xref: /OK3568_Linux_fs/kernel/Documentation/networking/ip-sysctl.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun
3*4882a593Smuzhiyun=========
4*4882a593SmuzhiyunIP Sysctl
5*4882a593Smuzhiyun=========
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun/proc/sys/net/ipv4/* Variables
8*4882a593Smuzhiyun==============================
9*4882a593Smuzhiyun
10*4882a593Smuzhiyunip_forward - BOOLEAN
11*4882a593Smuzhiyun	- 0 - disabled (default)
12*4882a593Smuzhiyun	- not 0 - enabled
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun	Forward Packets between interfaces.
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun	This variable is special, its change resets all configuration
17*4882a593Smuzhiyun	parameters to their default state (RFC1122 for hosts, RFC1812
18*4882a593Smuzhiyun	for routers)
19*4882a593Smuzhiyun
20*4882a593Smuzhiyunip_default_ttl - INTEGER
21*4882a593Smuzhiyun	Default value of TTL field (Time To Live) for outgoing (but not
22*4882a593Smuzhiyun	forwarded) IP packets. Should be between 1 and 255 inclusive.
23*4882a593Smuzhiyun	Default: 64 (as recommended by RFC1700)
24*4882a593Smuzhiyun
25*4882a593Smuzhiyunip_no_pmtu_disc - INTEGER
26*4882a593Smuzhiyun	Disable Path MTU Discovery. If enabled in mode 1 and a
27*4882a593Smuzhiyun	fragmentation-required ICMP is received, the PMTU to this
28*4882a593Smuzhiyun	destination will be set to min_pmtu (see below). You will need
29*4882a593Smuzhiyun	to raise min_pmtu to the smallest interface MTU on your system
30*4882a593Smuzhiyun	manually if you want to avoid locally generated fragments.
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun	In mode 2 incoming Path MTU Discovery messages will be
33*4882a593Smuzhiyun	discarded. Outgoing frames are handled the same as in mode 1,
34*4882a593Smuzhiyun	implicitly setting IP_PMTUDISC_DONT on every created socket.
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun	Mode 3 is a hardened pmtu discover mode. The kernel will only
37*4882a593Smuzhiyun	accept fragmentation-needed errors if the underlying protocol
38*4882a593Smuzhiyun	can verify them besides a plain socket lookup. Current
39*4882a593Smuzhiyun	protocols for which pmtu events will be honored are TCP, SCTP
40*4882a593Smuzhiyun	and DCCP as they verify e.g. the sequence number or the
41*4882a593Smuzhiyun	association. This mode should not be enabled globally but is
42*4882a593Smuzhiyun	only intended to secure e.g. name servers in namespaces where
43*4882a593Smuzhiyun	TCP path mtu must still work but path MTU information of other
44*4882a593Smuzhiyun	protocols should be discarded. If enabled globally this mode
45*4882a593Smuzhiyun	could break other protocols.
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun	Possible values: 0-3
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun	Default: FALSE
50*4882a593Smuzhiyun
51*4882a593Smuzhiyunmin_pmtu - INTEGER
52*4882a593Smuzhiyun	default 552 - minimum discovered Path MTU
53*4882a593Smuzhiyun
54*4882a593Smuzhiyunip_forward_use_pmtu - BOOLEAN
55*4882a593Smuzhiyun	By default we don't trust protocol path MTUs while forwarding
56*4882a593Smuzhiyun	because they could be easily forged and can lead to unwanted
57*4882a593Smuzhiyun	fragmentation by the router.
58*4882a593Smuzhiyun	You only need to enable this if you have user-space software
59*4882a593Smuzhiyun	which tries to discover path mtus by itself and depends on the
60*4882a593Smuzhiyun	kernel honoring this information. This is normally not the
61*4882a593Smuzhiyun	case.
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun	Default: 0 (disabled)
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun	Possible values:
66*4882a593Smuzhiyun
67*4882a593Smuzhiyun	- 0 - disabled
68*4882a593Smuzhiyun	- 1 - enabled
69*4882a593Smuzhiyun
70*4882a593Smuzhiyunfwmark_reflect - BOOLEAN
71*4882a593Smuzhiyun	Controls the fwmark of kernel-generated IPv4 reply packets that are not
72*4882a593Smuzhiyun	associated with a socket for example, TCP RSTs or ICMP echo replies).
73*4882a593Smuzhiyun	If unset, these packets have a fwmark of zero. If set, they have the
74*4882a593Smuzhiyun	fwmark of the packet they are replying to.
75*4882a593Smuzhiyun
76*4882a593Smuzhiyun	Default: 0
77*4882a593Smuzhiyun
78*4882a593Smuzhiyunfib_multipath_use_neigh - BOOLEAN
79*4882a593Smuzhiyun	Use status of existing neighbor entry when determining nexthop for
80*4882a593Smuzhiyun	multipath routes. If disabled, neighbor information is not used and
81*4882a593Smuzhiyun	packets could be directed to a failed nexthop. Only valid for kernels
82*4882a593Smuzhiyun	built with CONFIG_IP_ROUTE_MULTIPATH enabled.
83*4882a593Smuzhiyun
84*4882a593Smuzhiyun	Default: 0 (disabled)
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun	Possible values:
87*4882a593Smuzhiyun
88*4882a593Smuzhiyun	- 0 - disabled
89*4882a593Smuzhiyun	- 1 - enabled
90*4882a593Smuzhiyun
91*4882a593Smuzhiyunfib_multipath_hash_policy - INTEGER
92*4882a593Smuzhiyun	Controls which hash policy to use for multipath routes. Only valid
93*4882a593Smuzhiyun	for kernels built with CONFIG_IP_ROUTE_MULTIPATH enabled.
94*4882a593Smuzhiyun
95*4882a593Smuzhiyun	Default: 0 (Layer 3)
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun	Possible values:
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun	- 0 - Layer 3
100*4882a593Smuzhiyun	- 1 - Layer 4
101*4882a593Smuzhiyun	- 2 - Layer 3 or inner Layer 3 if present
102*4882a593Smuzhiyun
103*4882a593Smuzhiyunfib_sync_mem - UNSIGNED INTEGER
104*4882a593Smuzhiyun	Amount of dirty memory from fib entries that can be backlogged before
105*4882a593Smuzhiyun	synchronize_rcu is forced.
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun	Default: 512kB   Minimum: 64kB   Maximum: 64MB
108*4882a593Smuzhiyun
109*4882a593Smuzhiyunip_forward_update_priority - INTEGER
110*4882a593Smuzhiyun	Whether to update SKB priority from "TOS" field in IPv4 header after it
111*4882a593Smuzhiyun	is forwarded. The new SKB priority is mapped from TOS field value
112*4882a593Smuzhiyun	according to an rt_tos2priority table (see e.g. man tc-prio).
113*4882a593Smuzhiyun
114*4882a593Smuzhiyun	Default: 1 (Update priority.)
115*4882a593Smuzhiyun
116*4882a593Smuzhiyun	Possible values:
117*4882a593Smuzhiyun
118*4882a593Smuzhiyun	- 0 - Do not update priority.
119*4882a593Smuzhiyun	- 1 - Update priority.
120*4882a593Smuzhiyun
121*4882a593Smuzhiyunroute/max_size - INTEGER
122*4882a593Smuzhiyun	Maximum number of routes allowed in the kernel.  Increase
123*4882a593Smuzhiyun	this when using large numbers of interfaces and/or routes.
124*4882a593Smuzhiyun
125*4882a593Smuzhiyun	From linux kernel 3.6 onwards, this is deprecated for ipv4
126*4882a593Smuzhiyun	as route cache is no longer used.
127*4882a593Smuzhiyun
128*4882a593Smuzhiyunneigh/default/gc_thresh1 - INTEGER
129*4882a593Smuzhiyun	Minimum number of entries to keep.  Garbage collector will not
130*4882a593Smuzhiyun	purge entries if there are fewer than this number.
131*4882a593Smuzhiyun
132*4882a593Smuzhiyun	Default: 128
133*4882a593Smuzhiyun
134*4882a593Smuzhiyunneigh/default/gc_thresh2 - INTEGER
135*4882a593Smuzhiyun	Threshold when garbage collector becomes more aggressive about
136*4882a593Smuzhiyun	purging entries. Entries older than 5 seconds will be cleared
137*4882a593Smuzhiyun	when over this number.
138*4882a593Smuzhiyun
139*4882a593Smuzhiyun	Default: 512
140*4882a593Smuzhiyun
141*4882a593Smuzhiyunneigh/default/gc_thresh3 - INTEGER
142*4882a593Smuzhiyun	Maximum number of non-PERMANENT neighbor entries allowed.  Increase
143*4882a593Smuzhiyun	this when using large numbers of interfaces and when communicating
144*4882a593Smuzhiyun	with large numbers of directly-connected peers.
145*4882a593Smuzhiyun
146*4882a593Smuzhiyun	Default: 1024
147*4882a593Smuzhiyun
148*4882a593Smuzhiyunneigh/default/unres_qlen_bytes - INTEGER
149*4882a593Smuzhiyun	The maximum number of bytes which may be used by packets
150*4882a593Smuzhiyun	queued for each	unresolved address by other network layers.
151*4882a593Smuzhiyun	(added in linux 3.3)
152*4882a593Smuzhiyun
153*4882a593Smuzhiyun	Setting negative value is meaningless and will return error.
154*4882a593Smuzhiyun
155*4882a593Smuzhiyun	Default: SK_WMEM_MAX, (same as net.core.wmem_default).
156*4882a593Smuzhiyun
157*4882a593Smuzhiyun		Exact value depends on architecture and kernel options,
158*4882a593Smuzhiyun		but should be enough to allow queuing 256 packets
159*4882a593Smuzhiyun		of medium size.
160*4882a593Smuzhiyun
161*4882a593Smuzhiyunneigh/default/unres_qlen - INTEGER
162*4882a593Smuzhiyun	The maximum number of packets which may be queued for each
163*4882a593Smuzhiyun	unresolved address by other network layers.
164*4882a593Smuzhiyun
165*4882a593Smuzhiyun	(deprecated in linux 3.3) : use unres_qlen_bytes instead.
166*4882a593Smuzhiyun
167*4882a593Smuzhiyun	Prior to linux 3.3, the default value is 3 which may cause
168*4882a593Smuzhiyun	unexpected packet loss. The current default value is calculated
169*4882a593Smuzhiyun	according to default value of unres_qlen_bytes and true size of
170*4882a593Smuzhiyun	packet.
171*4882a593Smuzhiyun
172*4882a593Smuzhiyun	Default: 101
173*4882a593Smuzhiyun
174*4882a593Smuzhiyunmtu_expires - INTEGER
175*4882a593Smuzhiyun	Time, in seconds, that cached PMTU information is kept.
176*4882a593Smuzhiyun
177*4882a593Smuzhiyunmin_adv_mss - INTEGER
178*4882a593Smuzhiyun	The advertised MSS depends on the first hop route MTU, but will
179*4882a593Smuzhiyun	never be lower than this setting.
180*4882a593Smuzhiyun
181*4882a593SmuzhiyunIP Fragmentation:
182*4882a593Smuzhiyun
183*4882a593Smuzhiyunipfrag_high_thresh - LONG INTEGER
184*4882a593Smuzhiyun	Maximum memory used to reassemble IP fragments.
185*4882a593Smuzhiyun
186*4882a593Smuzhiyunipfrag_low_thresh - LONG INTEGER
187*4882a593Smuzhiyun	(Obsolete since linux-4.17)
188*4882a593Smuzhiyun	Maximum memory used to reassemble IP fragments before the kernel
189*4882a593Smuzhiyun	begins to remove incomplete fragment queues to free up resources.
190*4882a593Smuzhiyun	The kernel still accepts new fragments for defragmentation.
191*4882a593Smuzhiyun
192*4882a593Smuzhiyunipfrag_time - INTEGER
193*4882a593Smuzhiyun	Time in seconds to keep an IP fragment in memory.
194*4882a593Smuzhiyun
195*4882a593Smuzhiyunipfrag_max_dist - INTEGER
196*4882a593Smuzhiyun	ipfrag_max_dist is a non-negative integer value which defines the
197*4882a593Smuzhiyun	maximum "disorder" which is allowed among fragments which share a
198*4882a593Smuzhiyun	common IP source address. Note that reordering of packets is
199*4882a593Smuzhiyun	not unusual, but if a large number of fragments arrive from a source
200*4882a593Smuzhiyun	IP address while a particular fragment queue remains incomplete, it
201*4882a593Smuzhiyun	probably indicates that one or more fragments belonging to that queue
202*4882a593Smuzhiyun	have been lost. When ipfrag_max_dist is positive, an additional check
203*4882a593Smuzhiyun	is done on fragments before they are added to a reassembly queue - if
204*4882a593Smuzhiyun	ipfrag_max_dist (or more) fragments have arrived from a particular IP
205*4882a593Smuzhiyun	address between additions to any IP fragment queue using that source
206*4882a593Smuzhiyun	address, it's presumed that one or more fragments in the queue are
207*4882a593Smuzhiyun	lost. The existing fragment queue will be dropped, and a new one
208*4882a593Smuzhiyun	started. An ipfrag_max_dist value of zero disables this check.
209*4882a593Smuzhiyun
210*4882a593Smuzhiyun	Using a very small value, e.g. 1 or 2, for ipfrag_max_dist can
211*4882a593Smuzhiyun	result in unnecessarily dropping fragment queues when normal
212*4882a593Smuzhiyun	reordering of packets occurs, which could lead to poor application
213*4882a593Smuzhiyun	performance. Using a very large value, e.g. 50000, increases the
214*4882a593Smuzhiyun	likelihood of incorrectly reassembling IP fragments that originate
215*4882a593Smuzhiyun	from different IP datagrams, which could result in data corruption.
216*4882a593Smuzhiyun	Default: 64
217*4882a593Smuzhiyun
218*4882a593SmuzhiyunINET peer storage
219*4882a593Smuzhiyun=================
220*4882a593Smuzhiyun
221*4882a593Smuzhiyuninet_peer_threshold - INTEGER
222*4882a593Smuzhiyun	The approximate size of the storage.  Starting from this threshold
223*4882a593Smuzhiyun	entries will be thrown aggressively.  This threshold also determines
224*4882a593Smuzhiyun	entries' time-to-live and time intervals between garbage collection
225*4882a593Smuzhiyun	passes.  More entries, less time-to-live, less GC interval.
226*4882a593Smuzhiyun
227*4882a593Smuzhiyuninet_peer_minttl - INTEGER
228*4882a593Smuzhiyun	Minimum time-to-live of entries.  Should be enough to cover fragment
229*4882a593Smuzhiyun	time-to-live on the reassembling side.  This minimum time-to-live  is
230*4882a593Smuzhiyun	guaranteed if the pool size is less than inet_peer_threshold.
231*4882a593Smuzhiyun	Measured in seconds.
232*4882a593Smuzhiyun
233*4882a593Smuzhiyuninet_peer_maxttl - INTEGER
234*4882a593Smuzhiyun	Maximum time-to-live of entries.  Unused entries will expire after
235*4882a593Smuzhiyun	this period of time if there is no memory pressure on the pool (i.e.
236*4882a593Smuzhiyun	when the number of entries in the pool is very small).
237*4882a593Smuzhiyun	Measured in seconds.
238*4882a593Smuzhiyun
239*4882a593SmuzhiyunTCP variables
240*4882a593Smuzhiyun=============
241*4882a593Smuzhiyun
242*4882a593Smuzhiyunsomaxconn - INTEGER
243*4882a593Smuzhiyun	Limit of socket listen() backlog, known in userspace as SOMAXCONN.
244*4882a593Smuzhiyun	Defaults to 4096. (Was 128 before linux-5.4)
245*4882a593Smuzhiyun	See also tcp_max_syn_backlog for additional tuning for TCP sockets.
246*4882a593Smuzhiyun
247*4882a593Smuzhiyuntcp_abort_on_overflow - BOOLEAN
248*4882a593Smuzhiyun	If listening service is too slow to accept new connections,
249*4882a593Smuzhiyun	reset them. Default state is FALSE. It means that if overflow
250*4882a593Smuzhiyun	occurred due to a burst, connection will recover. Enable this
251*4882a593Smuzhiyun	option _only_ if you are really sure that listening daemon
252*4882a593Smuzhiyun	cannot be tuned to accept connections faster. Enabling this
253*4882a593Smuzhiyun	option can harm clients of your server.
254*4882a593Smuzhiyun
255*4882a593Smuzhiyuntcp_adv_win_scale - INTEGER
256*4882a593Smuzhiyun	Count buffering overhead as bytes/2^tcp_adv_win_scale
257*4882a593Smuzhiyun	(if tcp_adv_win_scale > 0) or bytes-bytes/2^(-tcp_adv_win_scale),
258*4882a593Smuzhiyun	if it is <= 0.
259*4882a593Smuzhiyun
260*4882a593Smuzhiyun	Possible values are [-31, 31], inclusive.
261*4882a593Smuzhiyun
262*4882a593Smuzhiyun	Default: 1
263*4882a593Smuzhiyun
264*4882a593Smuzhiyuntcp_allowed_congestion_control - STRING
265*4882a593Smuzhiyun	Show/set the congestion control choices available to non-privileged
266*4882a593Smuzhiyun	processes. The list is a subset of those listed in
267*4882a593Smuzhiyun	tcp_available_congestion_control.
268*4882a593Smuzhiyun
269*4882a593Smuzhiyun	Default is "reno" and the default setting (tcp_congestion_control).
270*4882a593Smuzhiyun
271*4882a593Smuzhiyuntcp_app_win - INTEGER
272*4882a593Smuzhiyun	Reserve max(window/2^tcp_app_win, mss) of window for application
273*4882a593Smuzhiyun	buffer. Value 0 is special, it means that nothing is reserved.
274*4882a593Smuzhiyun
275*4882a593Smuzhiyun	Default: 31
276*4882a593Smuzhiyun
277*4882a593Smuzhiyuntcp_autocorking - BOOLEAN
278*4882a593Smuzhiyun	Enable TCP auto corking :
279*4882a593Smuzhiyun	When applications do consecutive small write()/sendmsg() system calls,
280*4882a593Smuzhiyun	we try to coalesce these small writes as much as possible, to lower
281*4882a593Smuzhiyun	total amount of sent packets. This is done if at least one prior
282*4882a593Smuzhiyun	packet for the flow is waiting in Qdisc queues or device transmit
283*4882a593Smuzhiyun	queue. Applications can still use TCP_CORK for optimal behavior
284*4882a593Smuzhiyun	when they know how/when to uncork their sockets.
285*4882a593Smuzhiyun
286*4882a593Smuzhiyun	Default : 1
287*4882a593Smuzhiyun
288*4882a593Smuzhiyuntcp_available_congestion_control - STRING
289*4882a593Smuzhiyun	Shows the available congestion control choices that are registered.
290*4882a593Smuzhiyun	More congestion control algorithms may be available as modules,
291*4882a593Smuzhiyun	but not loaded.
292*4882a593Smuzhiyun
293*4882a593Smuzhiyuntcp_base_mss - INTEGER
294*4882a593Smuzhiyun	The initial value of search_low to be used by the packetization layer
295*4882a593Smuzhiyun	Path MTU discovery (MTU probing).  If MTU probing is enabled,
296*4882a593Smuzhiyun	this is the initial MSS used by the connection.
297*4882a593Smuzhiyun
298*4882a593Smuzhiyuntcp_mtu_probe_floor - INTEGER
299*4882a593Smuzhiyun	If MTU probing is enabled this caps the minimum MSS used for search_low
300*4882a593Smuzhiyun	for the connection.
301*4882a593Smuzhiyun
302*4882a593Smuzhiyun	Default : 48
303*4882a593Smuzhiyun
304*4882a593Smuzhiyuntcp_min_snd_mss - INTEGER
305*4882a593Smuzhiyun	TCP SYN and SYNACK messages usually advertise an ADVMSS option,
306*4882a593Smuzhiyun	as described in RFC 1122 and RFC 6691.
307*4882a593Smuzhiyun
308*4882a593Smuzhiyun	If this ADVMSS option is smaller than tcp_min_snd_mss,
309*4882a593Smuzhiyun	it is silently capped to tcp_min_snd_mss.
310*4882a593Smuzhiyun
311*4882a593Smuzhiyun	Default : 48 (at least 8 bytes of payload per segment)
312*4882a593Smuzhiyun
313*4882a593Smuzhiyuntcp_congestion_control - STRING
314*4882a593Smuzhiyun	Set the congestion control algorithm to be used for new
315*4882a593Smuzhiyun	connections. The algorithm "reno" is always available, but
316*4882a593Smuzhiyun	additional choices may be available based on kernel configuration.
317*4882a593Smuzhiyun	Default is set as part of kernel configuration.
318*4882a593Smuzhiyun	For passive connections, the listener congestion control choice
319*4882a593Smuzhiyun	is inherited.
320*4882a593Smuzhiyun
321*4882a593Smuzhiyun	[see setsockopt(listenfd, SOL_TCP, TCP_CONGESTION, "name" ...) ]
322*4882a593Smuzhiyun
323*4882a593Smuzhiyuntcp_dsack - BOOLEAN
324*4882a593Smuzhiyun	Allows TCP to send "duplicate" SACKs.
325*4882a593Smuzhiyun
326*4882a593Smuzhiyuntcp_early_retrans - INTEGER
327*4882a593Smuzhiyun	Tail loss probe (TLP) converts RTOs occurring due to tail
328*4882a593Smuzhiyun	losses into fast recovery (draft-ietf-tcpm-rack). Note that
329*4882a593Smuzhiyun	TLP requires RACK to function properly (see tcp_recovery below)
330*4882a593Smuzhiyun
331*4882a593Smuzhiyun	Possible values:
332*4882a593Smuzhiyun
333*4882a593Smuzhiyun		- 0 disables TLP
334*4882a593Smuzhiyun		- 3 or 4 enables TLP
335*4882a593Smuzhiyun
336*4882a593Smuzhiyun	Default: 3
337*4882a593Smuzhiyun
338*4882a593Smuzhiyuntcp_ecn - INTEGER
339*4882a593Smuzhiyun	Control use of Explicit Congestion Notification (ECN) by TCP.
340*4882a593Smuzhiyun	ECN is used only when both ends of the TCP connection indicate
341*4882a593Smuzhiyun	support for it.  This feature is useful in avoiding losses due
342*4882a593Smuzhiyun	to congestion by allowing supporting routers to signal
343*4882a593Smuzhiyun	congestion before having to drop packets.
344*4882a593Smuzhiyun
345*4882a593Smuzhiyun	Possible values are:
346*4882a593Smuzhiyun
347*4882a593Smuzhiyun		=  =====================================================
348*4882a593Smuzhiyun		0  Disable ECN.  Neither initiate nor accept ECN.
349*4882a593Smuzhiyun		1  Enable ECN when requested by incoming connections and
350*4882a593Smuzhiyun		   also request ECN on outgoing connection attempts.
351*4882a593Smuzhiyun		2  Enable ECN when requested by incoming connections
352*4882a593Smuzhiyun		   but do not request ECN on outgoing connections.
353*4882a593Smuzhiyun		=  =====================================================
354*4882a593Smuzhiyun
355*4882a593Smuzhiyun	Default: 2
356*4882a593Smuzhiyun
357*4882a593Smuzhiyuntcp_ecn_fallback - BOOLEAN
358*4882a593Smuzhiyun	If the kernel detects that ECN connection misbehaves, enable fall
359*4882a593Smuzhiyun	back to non-ECN. Currently, this knob implements the fallback
360*4882a593Smuzhiyun	from RFC3168, section 6.1.1.1., but we reserve that in future,
361*4882a593Smuzhiyun	additional detection mechanisms could be implemented under this
362*4882a593Smuzhiyun	knob. The value	is not used, if tcp_ecn or per route (or congestion
363*4882a593Smuzhiyun	control) ECN settings are disabled.
364*4882a593Smuzhiyun
365*4882a593Smuzhiyun	Default: 1 (fallback enabled)
366*4882a593Smuzhiyun
367*4882a593Smuzhiyuntcp_fack - BOOLEAN
368*4882a593Smuzhiyun	This is a legacy option, it has no effect anymore.
369*4882a593Smuzhiyun
370*4882a593Smuzhiyuntcp_fin_timeout - INTEGER
371*4882a593Smuzhiyun	The length of time an orphaned (no longer referenced by any
372*4882a593Smuzhiyun	application) connection will remain in the FIN_WAIT_2 state
373*4882a593Smuzhiyun	before it is aborted at the local end.  While a perfectly
374*4882a593Smuzhiyun	valid "receive only" state for an un-orphaned connection, an
375*4882a593Smuzhiyun	orphaned connection in FIN_WAIT_2 state could otherwise wait
376*4882a593Smuzhiyun	forever for the remote to close its end of the connection.
377*4882a593Smuzhiyun
378*4882a593Smuzhiyun	Cf. tcp_max_orphans
379*4882a593Smuzhiyun
380*4882a593Smuzhiyun	Default: 60 seconds
381*4882a593Smuzhiyun
382*4882a593Smuzhiyuntcp_frto - INTEGER
383*4882a593Smuzhiyun	Enables Forward RTO-Recovery (F-RTO) defined in RFC5682.
384*4882a593Smuzhiyun	F-RTO is an enhanced recovery algorithm for TCP retransmission
385*4882a593Smuzhiyun	timeouts.  It is particularly beneficial in networks where the
386*4882a593Smuzhiyun	RTT fluctuates (e.g., wireless). F-RTO is sender-side only
387*4882a593Smuzhiyun	modification. It does not require any support from the peer.
388*4882a593Smuzhiyun
389*4882a593Smuzhiyun	By default it's enabled with a non-zero value. 0 disables F-RTO.
390*4882a593Smuzhiyun
391*4882a593Smuzhiyuntcp_fwmark_accept - BOOLEAN
392*4882a593Smuzhiyun	If set, incoming connections to listening sockets that do not have a
393*4882a593Smuzhiyun	socket mark will set the mark of the accepting socket to the fwmark of
394*4882a593Smuzhiyun	the incoming SYN packet. This will cause all packets on that connection
395*4882a593Smuzhiyun	(starting from the first SYNACK) to be sent with that fwmark. The
396*4882a593Smuzhiyun	listening socket's mark is unchanged. Listening sockets that already
397*4882a593Smuzhiyun	have a fwmark set via setsockopt(SOL_SOCKET, SO_MARK, ...) are
398*4882a593Smuzhiyun	unaffected.
399*4882a593Smuzhiyun
400*4882a593Smuzhiyun	Default: 0
401*4882a593Smuzhiyun
402*4882a593Smuzhiyuntcp_invalid_ratelimit - INTEGER
403*4882a593Smuzhiyun	Limit the maximal rate for sending duplicate acknowledgments
404*4882a593Smuzhiyun	in response to incoming TCP packets that are for an existing
405*4882a593Smuzhiyun	connection but that are invalid due to any of these reasons:
406*4882a593Smuzhiyun
407*4882a593Smuzhiyun	  (a) out-of-window sequence number,
408*4882a593Smuzhiyun	  (b) out-of-window acknowledgment number, or
409*4882a593Smuzhiyun	  (c) PAWS (Protection Against Wrapped Sequence numbers) check failure
410*4882a593Smuzhiyun
411*4882a593Smuzhiyun	This can help mitigate simple "ack loop" DoS attacks, wherein
412*4882a593Smuzhiyun	a buggy or malicious middlebox or man-in-the-middle can
413*4882a593Smuzhiyun	rewrite TCP header fields in manner that causes each endpoint
414*4882a593Smuzhiyun	to think that the other is sending invalid TCP segments, thus
415*4882a593Smuzhiyun	causing each side to send an unterminating stream of duplicate
416*4882a593Smuzhiyun	acknowledgments for invalid segments.
417*4882a593Smuzhiyun
418*4882a593Smuzhiyun	Using 0 disables rate-limiting of dupacks in response to
419*4882a593Smuzhiyun	invalid segments; otherwise this value specifies the minimal
420*4882a593Smuzhiyun	space between sending such dupacks, in milliseconds.
421*4882a593Smuzhiyun
422*4882a593Smuzhiyun	Default: 500 (milliseconds).
423*4882a593Smuzhiyun
424*4882a593Smuzhiyuntcp_keepalive_time - INTEGER
425*4882a593Smuzhiyun	How often TCP sends out keepalive messages when keepalive is enabled.
426*4882a593Smuzhiyun	Default: 2hours.
427*4882a593Smuzhiyun
428*4882a593Smuzhiyuntcp_keepalive_probes - INTEGER
429*4882a593Smuzhiyun	How many keepalive probes TCP sends out, until it decides that the
430*4882a593Smuzhiyun	connection is broken. Default value: 9.
431*4882a593Smuzhiyun
432*4882a593Smuzhiyuntcp_keepalive_intvl - INTEGER
433*4882a593Smuzhiyun	How frequently the probes are send out. Multiplied by
434*4882a593Smuzhiyun	tcp_keepalive_probes it is time to kill not responding connection,
435*4882a593Smuzhiyun	after probes started. Default value: 75sec i.e. connection
436*4882a593Smuzhiyun	will be aborted after ~11 minutes of retries.
437*4882a593Smuzhiyun
438*4882a593Smuzhiyuntcp_l3mdev_accept - BOOLEAN
439*4882a593Smuzhiyun	Enables child sockets to inherit the L3 master device index.
440*4882a593Smuzhiyun	Enabling this option allows a "global" listen socket to work
441*4882a593Smuzhiyun	across L3 master domains (e.g., VRFs) with connected sockets
442*4882a593Smuzhiyun	derived from the listen socket to be bound to the L3 domain in
443*4882a593Smuzhiyun	which the packets originated. Only valid when the kernel was
444*4882a593Smuzhiyun	compiled with CONFIG_NET_L3_MASTER_DEV.
445*4882a593Smuzhiyun
446*4882a593Smuzhiyun	Default: 0 (disabled)
447*4882a593Smuzhiyun
448*4882a593Smuzhiyuntcp_low_latency - BOOLEAN
449*4882a593Smuzhiyun	This is a legacy option, it has no effect anymore.
450*4882a593Smuzhiyun
451*4882a593Smuzhiyuntcp_max_orphans - INTEGER
452*4882a593Smuzhiyun	Maximal number of TCP sockets not attached to any user file handle,
453*4882a593Smuzhiyun	held by system.	If this number is exceeded orphaned connections are
454*4882a593Smuzhiyun	reset immediately and warning is printed. This limit exists
455*4882a593Smuzhiyun	only to prevent simple DoS attacks, you _must_ not rely on this
456*4882a593Smuzhiyun	or lower the limit artificially, but rather increase it
457*4882a593Smuzhiyun	(probably, after increasing installed memory),
458*4882a593Smuzhiyun	if network conditions require more than default value,
459*4882a593Smuzhiyun	and tune network services to linger and kill such states
460*4882a593Smuzhiyun	more aggressively. Let me to remind again: each orphan eats
461*4882a593Smuzhiyun	up to ~64K of unswappable memory.
462*4882a593Smuzhiyun
463*4882a593Smuzhiyuntcp_max_syn_backlog - INTEGER
464*4882a593Smuzhiyun	Maximal number of remembered connection requests (SYN_RECV),
465*4882a593Smuzhiyun	which have not received an acknowledgment from connecting client.
466*4882a593Smuzhiyun
467*4882a593Smuzhiyun	This is a per-listener limit.
468*4882a593Smuzhiyun
469*4882a593Smuzhiyun	The minimal value is 128 for low memory machines, and it will
470*4882a593Smuzhiyun	increase in proportion to the memory of machine.
471*4882a593Smuzhiyun
472*4882a593Smuzhiyun	If server suffers from overload, try increasing this number.
473*4882a593Smuzhiyun
474*4882a593Smuzhiyun	Remember to also check /proc/sys/net/core/somaxconn
475*4882a593Smuzhiyun	A SYN_RECV request socket consumes about 304 bytes of memory.
476*4882a593Smuzhiyun
477*4882a593Smuzhiyuntcp_max_tw_buckets - INTEGER
478*4882a593Smuzhiyun	Maximal number of timewait sockets held by system simultaneously.
479*4882a593Smuzhiyun	If this number is exceeded time-wait socket is immediately destroyed
480*4882a593Smuzhiyun	and warning is printed. This limit exists only to prevent
481*4882a593Smuzhiyun	simple DoS attacks, you _must_ not lower the limit artificially,
482*4882a593Smuzhiyun	but rather increase it (probably, after increasing installed memory),
483*4882a593Smuzhiyun	if network conditions require more than default value.
484*4882a593Smuzhiyun
485*4882a593Smuzhiyuntcp_mem - vector of 3 INTEGERs: min, pressure, max
486*4882a593Smuzhiyun	min: below this number of pages TCP is not bothered about its
487*4882a593Smuzhiyun	memory appetite.
488*4882a593Smuzhiyun
489*4882a593Smuzhiyun	pressure: when amount of memory allocated by TCP exceeds this number
490*4882a593Smuzhiyun	of pages, TCP moderates its memory consumption and enters memory
491*4882a593Smuzhiyun	pressure mode, which is exited when memory consumption falls
492*4882a593Smuzhiyun	under "min".
493*4882a593Smuzhiyun
494*4882a593Smuzhiyun	max: number of pages allowed for queueing by all TCP sockets.
495*4882a593Smuzhiyun
496*4882a593Smuzhiyun	Defaults are calculated at boot time from amount of available
497*4882a593Smuzhiyun	memory.
498*4882a593Smuzhiyun
499*4882a593Smuzhiyuntcp_min_rtt_wlen - INTEGER
500*4882a593Smuzhiyun	The window length of the windowed min filter to track the minimum RTT.
501*4882a593Smuzhiyun	A shorter window lets a flow more quickly pick up new (higher)
502*4882a593Smuzhiyun	minimum RTT when it is moved to a longer path (e.g., due to traffic
503*4882a593Smuzhiyun	engineering). A longer window makes the filter more resistant to RTT
504*4882a593Smuzhiyun	inflations such as transient congestion. The unit is seconds.
505*4882a593Smuzhiyun
506*4882a593Smuzhiyun	Possible values: 0 - 86400 (1 day)
507*4882a593Smuzhiyun
508*4882a593Smuzhiyun	Default: 300
509*4882a593Smuzhiyun
510*4882a593Smuzhiyuntcp_moderate_rcvbuf - BOOLEAN
511*4882a593Smuzhiyun	If set, TCP performs receive buffer auto-tuning, attempting to
512*4882a593Smuzhiyun	automatically size the buffer (no greater than tcp_rmem[2]) to
513*4882a593Smuzhiyun	match the size required by the path for full throughput.  Enabled by
514*4882a593Smuzhiyun	default.
515*4882a593Smuzhiyun
516*4882a593Smuzhiyuntcp_mtu_probing - INTEGER
517*4882a593Smuzhiyun	Controls TCP Packetization-Layer Path MTU Discovery.  Takes three
518*4882a593Smuzhiyun	values:
519*4882a593Smuzhiyun
520*4882a593Smuzhiyun	- 0 - Disabled
521*4882a593Smuzhiyun	- 1 - Disabled by default, enabled when an ICMP black hole detected
522*4882a593Smuzhiyun	- 2 - Always enabled, use initial MSS of tcp_base_mss.
523*4882a593Smuzhiyun
524*4882a593Smuzhiyuntcp_probe_interval - UNSIGNED INTEGER
525*4882a593Smuzhiyun	Controls how often to start TCP Packetization-Layer Path MTU
526*4882a593Smuzhiyun	Discovery reprobe. The default is reprobing every 10 minutes as
527*4882a593Smuzhiyun	per RFC4821.
528*4882a593Smuzhiyun
529*4882a593Smuzhiyuntcp_probe_threshold - INTEGER
530*4882a593Smuzhiyun	Controls when TCP Packetization-Layer Path MTU Discovery probing
531*4882a593Smuzhiyun	will stop in respect to the width of search range in bytes. Default
532*4882a593Smuzhiyun	is 8 bytes.
533*4882a593Smuzhiyun
534*4882a593Smuzhiyuntcp_no_metrics_save - BOOLEAN
535*4882a593Smuzhiyun	By default, TCP saves various connection metrics in the route cache
536*4882a593Smuzhiyun	when the connection closes, so that connections established in the
537*4882a593Smuzhiyun	near future can use these to set initial conditions.  Usually, this
538*4882a593Smuzhiyun	increases overall performance, but may sometimes cause performance
539*4882a593Smuzhiyun	degradation.  If set, TCP will not cache metrics on closing
540*4882a593Smuzhiyun	connections.
541*4882a593Smuzhiyun
542*4882a593Smuzhiyuntcp_no_ssthresh_metrics_save - BOOLEAN
543*4882a593Smuzhiyun	Controls whether TCP saves ssthresh metrics in the route cache.
544*4882a593Smuzhiyun
545*4882a593Smuzhiyun	Default is 1, which disables ssthresh metrics.
546*4882a593Smuzhiyun
547*4882a593Smuzhiyuntcp_orphan_retries - INTEGER
548*4882a593Smuzhiyun	This value influences the timeout of a locally closed TCP connection,
549*4882a593Smuzhiyun	when RTO retransmissions remain unacknowledged.
550*4882a593Smuzhiyun	See tcp_retries2 for more details.
551*4882a593Smuzhiyun
552*4882a593Smuzhiyun	The default value is 8.
553*4882a593Smuzhiyun
554*4882a593Smuzhiyun	If your machine is a loaded WEB server,
555*4882a593Smuzhiyun	you should think about lowering this value, such sockets
556*4882a593Smuzhiyun	may consume significant resources. Cf. tcp_max_orphans.
557*4882a593Smuzhiyun
558*4882a593Smuzhiyuntcp_recovery - INTEGER
559*4882a593Smuzhiyun	This value is a bitmap to enable various experimental loss recovery
560*4882a593Smuzhiyun	features.
561*4882a593Smuzhiyun
562*4882a593Smuzhiyun	=========   =============================================================
563*4882a593Smuzhiyun	RACK: 0x1   enables the RACK loss detection for fast detection of lost
564*4882a593Smuzhiyun		    retransmissions and tail drops. It also subsumes and disables
565*4882a593Smuzhiyun		    RFC6675 recovery for SACK connections.
566*4882a593Smuzhiyun
567*4882a593Smuzhiyun	RACK: 0x2   makes RACK's reordering window static (min_rtt/4).
568*4882a593Smuzhiyun
569*4882a593Smuzhiyun	RACK: 0x4   disables RACK's DUPACK threshold heuristic
570*4882a593Smuzhiyun	=========   =============================================================
571*4882a593Smuzhiyun
572*4882a593Smuzhiyun	Default: 0x1
573*4882a593Smuzhiyun
574*4882a593Smuzhiyuntcp_reordering - INTEGER
575*4882a593Smuzhiyun	Initial reordering level of packets in a TCP stream.
576*4882a593Smuzhiyun	TCP stack can then dynamically adjust flow reordering level
577*4882a593Smuzhiyun	between this initial value and tcp_max_reordering
578*4882a593Smuzhiyun
579*4882a593Smuzhiyun	Default: 3
580*4882a593Smuzhiyun
581*4882a593Smuzhiyuntcp_max_reordering - INTEGER
582*4882a593Smuzhiyun	Maximal reordering level of packets in a TCP stream.
583*4882a593Smuzhiyun	300 is a fairly conservative value, but you might increase it
584*4882a593Smuzhiyun	if paths are using per packet load balancing (like bonding rr mode)
585*4882a593Smuzhiyun
586*4882a593Smuzhiyun	Default: 300
587*4882a593Smuzhiyun
588*4882a593Smuzhiyuntcp_retrans_collapse - BOOLEAN
589*4882a593Smuzhiyun	Bug-to-bug compatibility with some broken printers.
590*4882a593Smuzhiyun	On retransmit try to send bigger packets to work around bugs in
591*4882a593Smuzhiyun	certain TCP stacks.
592*4882a593Smuzhiyun
593*4882a593Smuzhiyuntcp_retries1 - INTEGER
594*4882a593Smuzhiyun	This value influences the time, after which TCP decides, that
595*4882a593Smuzhiyun	something is wrong due to unacknowledged RTO retransmissions,
596*4882a593Smuzhiyun	and reports this suspicion to the network layer.
597*4882a593Smuzhiyun	See tcp_retries2 for more details.
598*4882a593Smuzhiyun
599*4882a593Smuzhiyun	RFC 1122 recommends at least 3 retransmissions, which is the
600*4882a593Smuzhiyun	default.
601*4882a593Smuzhiyun
602*4882a593Smuzhiyuntcp_retries2 - INTEGER
603*4882a593Smuzhiyun	This value influences the timeout of an alive TCP connection,
604*4882a593Smuzhiyun	when RTO retransmissions remain unacknowledged.
605*4882a593Smuzhiyun	Given a value of N, a hypothetical TCP connection following
606*4882a593Smuzhiyun	exponential backoff with an initial RTO of TCP_RTO_MIN would
607*4882a593Smuzhiyun	retransmit N times before killing the connection at the (N+1)th RTO.
608*4882a593Smuzhiyun
609*4882a593Smuzhiyun	The default value of 15 yields a hypothetical timeout of 924.6
610*4882a593Smuzhiyun	seconds and is a lower bound for the effective timeout.
611*4882a593Smuzhiyun	TCP will effectively time out at the first RTO which exceeds the
612*4882a593Smuzhiyun	hypothetical timeout.
613*4882a593Smuzhiyun
614*4882a593Smuzhiyun	RFC 1122 recommends at least 100 seconds for the timeout,
615*4882a593Smuzhiyun	which corresponds to a value of at least 8.
616*4882a593Smuzhiyun
617*4882a593Smuzhiyuntcp_rfc1337 - BOOLEAN
618*4882a593Smuzhiyun	If set, the TCP stack behaves conforming to RFC1337. If unset,
619*4882a593Smuzhiyun	we are not conforming to RFC, but prevent TCP TIME_WAIT
620*4882a593Smuzhiyun	assassination.
621*4882a593Smuzhiyun
622*4882a593Smuzhiyun	Default: 0
623*4882a593Smuzhiyun
624*4882a593Smuzhiyuntcp_rmem - vector of 3 INTEGERs: min, default, max
625*4882a593Smuzhiyun	min: Minimal size of receive buffer used by TCP sockets.
626*4882a593Smuzhiyun	It is guaranteed to each TCP socket, even under moderate memory
627*4882a593Smuzhiyun	pressure.
628*4882a593Smuzhiyun
629*4882a593Smuzhiyun	Default: 4K
630*4882a593Smuzhiyun
631*4882a593Smuzhiyun	default: initial size of receive buffer used by TCP sockets.
632*4882a593Smuzhiyun	This value overrides net.core.rmem_default used by other protocols.
633*4882a593Smuzhiyun	Default: 131072 bytes.
634*4882a593Smuzhiyun	This value results in initial window of 65535.
635*4882a593Smuzhiyun
636*4882a593Smuzhiyun	max: maximal size of receive buffer allowed for automatically
637*4882a593Smuzhiyun	selected receiver buffers for TCP socket. This value does not override
638*4882a593Smuzhiyun	net.core.rmem_max.  Calling setsockopt() with SO_RCVBUF disables
639*4882a593Smuzhiyun	automatic tuning of that socket's receive buffer size, in which
640*4882a593Smuzhiyun	case this value is ignored.
641*4882a593Smuzhiyun	Default: between 131072 and 6MB, depending on RAM size.
642*4882a593Smuzhiyun
643*4882a593Smuzhiyuntcp_sack - BOOLEAN
644*4882a593Smuzhiyun	Enable select acknowledgments (SACKS).
645*4882a593Smuzhiyun
646*4882a593Smuzhiyuntcp_comp_sack_delay_ns - LONG INTEGER
647*4882a593Smuzhiyun	TCP tries to reduce number of SACK sent, using a timer
648*4882a593Smuzhiyun	based on 5% of SRTT, capped by this sysctl, in nano seconds.
649*4882a593Smuzhiyun	The default is 1ms, based on TSO autosizing period.
650*4882a593Smuzhiyun
651*4882a593Smuzhiyun	Default : 1,000,000 ns (1 ms)
652*4882a593Smuzhiyun
653*4882a593Smuzhiyuntcp_comp_sack_slack_ns - LONG INTEGER
654*4882a593Smuzhiyun	This sysctl control the slack used when arming the
655*4882a593Smuzhiyun	timer used by SACK compression. This gives extra time
656*4882a593Smuzhiyun	for small RTT flows, and reduces system overhead by allowing
657*4882a593Smuzhiyun	opportunistic reduction of timer interrupts.
658*4882a593Smuzhiyun
659*4882a593Smuzhiyun	Default : 100,000 ns (100 us)
660*4882a593Smuzhiyun
661*4882a593Smuzhiyuntcp_comp_sack_nr - INTEGER
662*4882a593Smuzhiyun	Max number of SACK that can be compressed.
663*4882a593Smuzhiyun	Using 0 disables SACK compression.
664*4882a593Smuzhiyun
665*4882a593Smuzhiyun	Default : 44
666*4882a593Smuzhiyun
667*4882a593Smuzhiyuntcp_slow_start_after_idle - BOOLEAN
668*4882a593Smuzhiyun	If set, provide RFC2861 behavior and time out the congestion
669*4882a593Smuzhiyun	window after an idle period.  An idle period is defined at
670*4882a593Smuzhiyun	the current RTO.  If unset, the congestion window will not
671*4882a593Smuzhiyun	be timed out after an idle period.
672*4882a593Smuzhiyun
673*4882a593Smuzhiyun	Default: 1
674*4882a593Smuzhiyun
675*4882a593Smuzhiyuntcp_stdurg - BOOLEAN
676*4882a593Smuzhiyun	Use the Host requirements interpretation of the TCP urgent pointer field.
677*4882a593Smuzhiyun	Most hosts use the older BSD interpretation, so if you turn this on
678*4882a593Smuzhiyun	Linux might not communicate correctly with them.
679*4882a593Smuzhiyun
680*4882a593Smuzhiyun	Default: FALSE
681*4882a593Smuzhiyun
682*4882a593Smuzhiyuntcp_synack_retries - INTEGER
683*4882a593Smuzhiyun	Number of times SYNACKs for a passive TCP connection attempt will
684*4882a593Smuzhiyun	be retransmitted. Should not be higher than 255. Default value
685*4882a593Smuzhiyun	is 5, which corresponds to 31seconds till the last retransmission
686*4882a593Smuzhiyun	with the current initial RTO of 1second. With this the final timeout
687*4882a593Smuzhiyun	for a passive TCP connection will happen after 63seconds.
688*4882a593Smuzhiyun
689*4882a593Smuzhiyuntcp_syncookies - INTEGER
690*4882a593Smuzhiyun	Only valid when the kernel was compiled with CONFIG_SYN_COOKIES
691*4882a593Smuzhiyun	Send out syncookies when the syn backlog queue of a socket
692*4882a593Smuzhiyun	overflows. This is to prevent against the common 'SYN flood attack'
693*4882a593Smuzhiyun	Default: 1
694*4882a593Smuzhiyun
695*4882a593Smuzhiyun	Note, that syncookies is fallback facility.
696*4882a593Smuzhiyun	It MUST NOT be used to help highly loaded servers to stand
697*4882a593Smuzhiyun	against legal connection rate. If you see SYN flood warnings
698*4882a593Smuzhiyun	in your logs, but investigation	shows that they occur
699*4882a593Smuzhiyun	because of overload with legal connections, you should tune
700*4882a593Smuzhiyun	another parameters until this warning disappear.
701*4882a593Smuzhiyun	See: tcp_max_syn_backlog, tcp_synack_retries, tcp_abort_on_overflow.
702*4882a593Smuzhiyun
703*4882a593Smuzhiyun	syncookies seriously violate TCP protocol, do not allow
704*4882a593Smuzhiyun	to use TCP extensions, can result in serious degradation
705*4882a593Smuzhiyun	of some services (f.e. SMTP relaying), visible not by you,
706*4882a593Smuzhiyun	but your clients and relays, contacting you. While you see
707*4882a593Smuzhiyun	SYN flood warnings in logs not being really flooded, your server
708*4882a593Smuzhiyun	is seriously misconfigured.
709*4882a593Smuzhiyun
710*4882a593Smuzhiyun	If you want to test which effects syncookies have to your
711*4882a593Smuzhiyun	network connections you can set this knob to 2 to enable
712*4882a593Smuzhiyun	unconditionally generation of syncookies.
713*4882a593Smuzhiyun
714*4882a593Smuzhiyuntcp_fastopen - INTEGER
715*4882a593Smuzhiyun	Enable TCP Fast Open (RFC7413) to send and accept data in the opening
716*4882a593Smuzhiyun	SYN packet.
717*4882a593Smuzhiyun
718*4882a593Smuzhiyun	The client support is enabled by flag 0x1 (on by default). The client
719*4882a593Smuzhiyun	then must use sendmsg() or sendto() with the MSG_FASTOPEN flag,
720*4882a593Smuzhiyun	rather than connect() to send data in SYN.
721*4882a593Smuzhiyun
722*4882a593Smuzhiyun	The server support is enabled by flag 0x2 (off by default). Then
723*4882a593Smuzhiyun	either enable for all listeners with another flag (0x400) or
724*4882a593Smuzhiyun	enable individual listeners via TCP_FASTOPEN socket option with
725*4882a593Smuzhiyun	the option value being the length of the syn-data backlog.
726*4882a593Smuzhiyun
727*4882a593Smuzhiyun	The values (bitmap) are
728*4882a593Smuzhiyun
729*4882a593Smuzhiyun	=====  ======== ======================================================
730*4882a593Smuzhiyun	  0x1  (client) enables sending data in the opening SYN on the client.
731*4882a593Smuzhiyun	  0x2  (server) enables the server support, i.e., allowing data in
732*4882a593Smuzhiyun			a SYN packet to be accepted and passed to the
733*4882a593Smuzhiyun			application before 3-way handshake finishes.
734*4882a593Smuzhiyun	  0x4  (client) send data in the opening SYN regardless of cookie
735*4882a593Smuzhiyun			availability and without a cookie option.
736*4882a593Smuzhiyun	0x200  (server) accept data-in-SYN w/o any cookie option present.
737*4882a593Smuzhiyun	0x400  (server) enable all listeners to support Fast Open by
738*4882a593Smuzhiyun			default without explicit TCP_FASTOPEN socket option.
739*4882a593Smuzhiyun	=====  ======== ======================================================
740*4882a593Smuzhiyun
741*4882a593Smuzhiyun	Default: 0x1
742*4882a593Smuzhiyun
743*4882a593Smuzhiyun	Note that additional client or server features are only
744*4882a593Smuzhiyun	effective if the basic support (0x1 and 0x2) are enabled respectively.
745*4882a593Smuzhiyun
746*4882a593Smuzhiyuntcp_fastopen_blackhole_timeout_sec - INTEGER
747*4882a593Smuzhiyun	Initial time period in second to disable Fastopen on active TCP sockets
748*4882a593Smuzhiyun	when a TFO firewall blackhole issue happens.
749*4882a593Smuzhiyun	This time period will grow exponentially when more blackhole issues
750*4882a593Smuzhiyun	get detected right after Fastopen is re-enabled and will reset to
751*4882a593Smuzhiyun	initial value when the blackhole issue goes away.
752*4882a593Smuzhiyun	0 to disable the blackhole detection.
753*4882a593Smuzhiyun
754*4882a593Smuzhiyun	By default, it is set to 0 (feature is disabled).
755*4882a593Smuzhiyun
756*4882a593Smuzhiyuntcp_fastopen_key - list of comma separated 32-digit hexadecimal INTEGERs
757*4882a593Smuzhiyun	The list consists of a primary key and an optional backup key. The
758*4882a593Smuzhiyun	primary key is used for both creating and validating cookies, while the
759*4882a593Smuzhiyun	optional backup key is only used for validating cookies. The purpose of
760*4882a593Smuzhiyun	the backup key is to maximize TFO validation when keys are rotated.
761*4882a593Smuzhiyun
762*4882a593Smuzhiyun	A randomly chosen primary key may be configured by the kernel if
763*4882a593Smuzhiyun	the tcp_fastopen sysctl is set to 0x400 (see above), or if the
764*4882a593Smuzhiyun	TCP_FASTOPEN setsockopt() optname is set and a key has not been
765*4882a593Smuzhiyun	previously configured via sysctl. If keys are configured via
766*4882a593Smuzhiyun	setsockopt() by using the TCP_FASTOPEN_KEY optname, then those
767*4882a593Smuzhiyun	per-socket keys will be used instead of any keys that are specified via
768*4882a593Smuzhiyun	sysctl.
769*4882a593Smuzhiyun
770*4882a593Smuzhiyun	A key is specified as 4 8-digit hexadecimal integers which are separated
771*4882a593Smuzhiyun	by a '-' as: xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx. Leading zeros may be
772*4882a593Smuzhiyun	omitted. A primary and a backup key may be specified by separating them
773*4882a593Smuzhiyun	by a comma. If only one key is specified, it becomes the primary key and
774*4882a593Smuzhiyun	any previously configured backup keys are removed.
775*4882a593Smuzhiyun
776*4882a593Smuzhiyuntcp_syn_retries - INTEGER
777*4882a593Smuzhiyun	Number of times initial SYNs for an active TCP connection attempt
778*4882a593Smuzhiyun	will be retransmitted. Should not be higher than 127. Default value
779*4882a593Smuzhiyun	is 6, which corresponds to 63seconds till the last retransmission
780*4882a593Smuzhiyun	with the current initial RTO of 1second. With this the final timeout
781*4882a593Smuzhiyun	for an active TCP connection attempt will happen after 127seconds.
782*4882a593Smuzhiyun
783*4882a593Smuzhiyuntcp_timestamps - INTEGER
784*4882a593Smuzhiyun	Enable timestamps as defined in RFC1323.
785*4882a593Smuzhiyun
786*4882a593Smuzhiyun	- 0: Disabled.
787*4882a593Smuzhiyun	- 1: Enable timestamps as defined in RFC1323 and use random offset for
788*4882a593Smuzhiyun	  each connection rather than only using the current time.
789*4882a593Smuzhiyun	- 2: Like 1, but without random offsets.
790*4882a593Smuzhiyun
791*4882a593Smuzhiyun	Default: 1
792*4882a593Smuzhiyun
793*4882a593Smuzhiyuntcp_min_tso_segs - INTEGER
794*4882a593Smuzhiyun	Minimal number of segments per TSO frame.
795*4882a593Smuzhiyun
796*4882a593Smuzhiyun	Since linux-3.12, TCP does an automatic sizing of TSO frames,
797*4882a593Smuzhiyun	depending on flow rate, instead of filling 64Kbytes packets.
798*4882a593Smuzhiyun	For specific usages, it's possible to force TCP to build big
799*4882a593Smuzhiyun	TSO frames. Note that TCP stack might split too big TSO packets
800*4882a593Smuzhiyun	if available window is too small.
801*4882a593Smuzhiyun
802*4882a593Smuzhiyun	Default: 2
803*4882a593Smuzhiyun
804*4882a593Smuzhiyuntcp_pacing_ss_ratio - INTEGER
805*4882a593Smuzhiyun	sk->sk_pacing_rate is set by TCP stack using a ratio applied
806*4882a593Smuzhiyun	to current rate. (current_rate = cwnd * mss / srtt)
807*4882a593Smuzhiyun	If TCP is in slow start, tcp_pacing_ss_ratio is applied
808*4882a593Smuzhiyun	to let TCP probe for bigger speeds, assuming cwnd can be
809*4882a593Smuzhiyun	doubled every other RTT.
810*4882a593Smuzhiyun
811*4882a593Smuzhiyun	Default: 200
812*4882a593Smuzhiyun
813*4882a593Smuzhiyuntcp_pacing_ca_ratio - INTEGER
814*4882a593Smuzhiyun	sk->sk_pacing_rate is set by TCP stack using a ratio applied
815*4882a593Smuzhiyun	to current rate. (current_rate = cwnd * mss / srtt)
816*4882a593Smuzhiyun	If TCP is in congestion avoidance phase, tcp_pacing_ca_ratio
817*4882a593Smuzhiyun	is applied to conservatively probe for bigger throughput.
818*4882a593Smuzhiyun
819*4882a593Smuzhiyun	Default: 120
820*4882a593Smuzhiyun
821*4882a593Smuzhiyuntcp_tso_win_divisor - INTEGER
822*4882a593Smuzhiyun	This allows control over what percentage of the congestion window
823*4882a593Smuzhiyun	can be consumed by a single TSO frame.
824*4882a593Smuzhiyun	The setting of this parameter is a choice between burstiness and
825*4882a593Smuzhiyun	building larger TSO frames.
826*4882a593Smuzhiyun
827*4882a593Smuzhiyun	Default: 3
828*4882a593Smuzhiyun
829*4882a593Smuzhiyuntcp_tw_reuse - INTEGER
830*4882a593Smuzhiyun	Enable reuse of TIME-WAIT sockets for new connections when it is
831*4882a593Smuzhiyun	safe from protocol viewpoint.
832*4882a593Smuzhiyun
833*4882a593Smuzhiyun	- 0 - disable
834*4882a593Smuzhiyun	- 1 - global enable
835*4882a593Smuzhiyun	- 2 - enable for loopback traffic only
836*4882a593Smuzhiyun
837*4882a593Smuzhiyun	It should not be changed without advice/request of technical
838*4882a593Smuzhiyun	experts.
839*4882a593Smuzhiyun
840*4882a593Smuzhiyun	Default: 2
841*4882a593Smuzhiyun
842*4882a593Smuzhiyuntcp_window_scaling - BOOLEAN
843*4882a593Smuzhiyun	Enable window scaling as defined in RFC1323.
844*4882a593Smuzhiyun
845*4882a593Smuzhiyuntcp_wmem - vector of 3 INTEGERs: min, default, max
846*4882a593Smuzhiyun	min: Amount of memory reserved for send buffers for TCP sockets.
847*4882a593Smuzhiyun	Each TCP socket has rights to use it due to fact of its birth.
848*4882a593Smuzhiyun
849*4882a593Smuzhiyun	Default: 4K
850*4882a593Smuzhiyun
851*4882a593Smuzhiyun	default: initial size of send buffer used by TCP sockets.  This
852*4882a593Smuzhiyun	value overrides net.core.wmem_default used by other protocols.
853*4882a593Smuzhiyun
854*4882a593Smuzhiyun	It is usually lower than net.core.wmem_default.
855*4882a593Smuzhiyun
856*4882a593Smuzhiyun	Default: 16K
857*4882a593Smuzhiyun
858*4882a593Smuzhiyun	max: Maximal amount of memory allowed for automatically tuned
859*4882a593Smuzhiyun	send buffers for TCP sockets. This value does not override
860*4882a593Smuzhiyun	net.core.wmem_max.  Calling setsockopt() with SO_SNDBUF disables
861*4882a593Smuzhiyun	automatic tuning of that socket's send buffer size, in which case
862*4882a593Smuzhiyun	this value is ignored.
863*4882a593Smuzhiyun
864*4882a593Smuzhiyun	Default: between 64K and 4MB, depending on RAM size.
865*4882a593Smuzhiyun
866*4882a593Smuzhiyuntcp_notsent_lowat - UNSIGNED INTEGER
867*4882a593Smuzhiyun	A TCP socket can control the amount of unsent bytes in its write queue,
868*4882a593Smuzhiyun	thanks to TCP_NOTSENT_LOWAT socket option. poll()/select()/epoll()
869*4882a593Smuzhiyun	reports POLLOUT events if the amount of unsent bytes is below a per
870*4882a593Smuzhiyun	socket value, and if the write queue is not full. sendmsg() will
871*4882a593Smuzhiyun	also not add new buffers if the limit is hit.
872*4882a593Smuzhiyun
873*4882a593Smuzhiyun	This global variable controls the amount of unsent data for
874*4882a593Smuzhiyun	sockets not using TCP_NOTSENT_LOWAT. For these sockets, a change
875*4882a593Smuzhiyun	to the global variable has immediate effect.
876*4882a593Smuzhiyun
877*4882a593Smuzhiyun	Default: UINT_MAX (0xFFFFFFFF)
878*4882a593Smuzhiyun
879*4882a593Smuzhiyuntcp_workaround_signed_windows - BOOLEAN
880*4882a593Smuzhiyun	If set, assume no receipt of a window scaling option means the
881*4882a593Smuzhiyun	remote TCP is broken and treats the window as a signed quantity.
882*4882a593Smuzhiyun	If unset, assume the remote TCP is not broken even if we do
883*4882a593Smuzhiyun	not receive a window scaling option from them.
884*4882a593Smuzhiyun
885*4882a593Smuzhiyun	Default: 0
886*4882a593Smuzhiyun
887*4882a593Smuzhiyuntcp_thin_linear_timeouts - BOOLEAN
888*4882a593Smuzhiyun	Enable dynamic triggering of linear timeouts for thin streams.
889*4882a593Smuzhiyun	If set, a check is performed upon retransmission by timeout to
890*4882a593Smuzhiyun	determine if the stream is thin (less than 4 packets in flight).
891*4882a593Smuzhiyun	As long as the stream is found to be thin, up to 6 linear
892*4882a593Smuzhiyun	timeouts may be performed before exponential backoff mode is
893*4882a593Smuzhiyun	initiated. This improves retransmission latency for
894*4882a593Smuzhiyun	non-aggressive thin streams, often found to be time-dependent.
895*4882a593Smuzhiyun	For more information on thin streams, see
896*4882a593Smuzhiyun	Documentation/networking/tcp-thin.rst
897*4882a593Smuzhiyun
898*4882a593Smuzhiyun	Default: 0
899*4882a593Smuzhiyun
900*4882a593Smuzhiyuntcp_limit_output_bytes - INTEGER
901*4882a593Smuzhiyun	Controls TCP Small Queue limit per tcp socket.
902*4882a593Smuzhiyun	TCP bulk sender tends to increase packets in flight until it
903*4882a593Smuzhiyun	gets losses notifications. With SNDBUF autotuning, this can
904*4882a593Smuzhiyun	result in a large amount of packets queued on the local machine
905*4882a593Smuzhiyun	(e.g.: qdiscs, CPU backlog, or device) hurting latency of other
906*4882a593Smuzhiyun	flows, for typical pfifo_fast qdiscs.  tcp_limit_output_bytes
907*4882a593Smuzhiyun	limits the number of bytes on qdisc or device to reduce artificial
908*4882a593Smuzhiyun	RTT/cwnd and reduce bufferbloat.
909*4882a593Smuzhiyun
910*4882a593Smuzhiyun	Default: 1048576 (16 * 65536)
911*4882a593Smuzhiyun
912*4882a593Smuzhiyuntcp_challenge_ack_limit - INTEGER
913*4882a593Smuzhiyun	Limits number of Challenge ACK sent per second, as recommended
914*4882a593Smuzhiyun	in RFC 5961 (Improving TCP's Robustness to Blind In-Window Attacks)
915*4882a593Smuzhiyun	Default: 1000
916*4882a593Smuzhiyun
917*4882a593Smuzhiyuntcp_rx_skb_cache - BOOLEAN
918*4882a593Smuzhiyun	Controls a per TCP socket cache of one skb, that might help
919*4882a593Smuzhiyun	performance of some workloads. This might be dangerous
920*4882a593Smuzhiyun	on systems with a lot of TCP sockets, since it increases
921*4882a593Smuzhiyun	memory usage.
922*4882a593Smuzhiyun
923*4882a593Smuzhiyun	Default: 0 (disabled)
924*4882a593Smuzhiyun
925*4882a593SmuzhiyunUDP variables
926*4882a593Smuzhiyun=============
927*4882a593Smuzhiyun
928*4882a593Smuzhiyunudp_l3mdev_accept - BOOLEAN
929*4882a593Smuzhiyun	Enabling this option allows a "global" bound socket to work
930*4882a593Smuzhiyun	across L3 master domains (e.g., VRFs) with packets capable of
931*4882a593Smuzhiyun	being received regardless of the L3 domain in which they
932*4882a593Smuzhiyun	originated. Only valid when the kernel was compiled with
933*4882a593Smuzhiyun	CONFIG_NET_L3_MASTER_DEV.
934*4882a593Smuzhiyun
935*4882a593Smuzhiyun	Default: 0 (disabled)
936*4882a593Smuzhiyun
937*4882a593Smuzhiyunudp_mem - vector of 3 INTEGERs: min, pressure, max
938*4882a593Smuzhiyun	Number of pages allowed for queueing by all UDP sockets.
939*4882a593Smuzhiyun
940*4882a593Smuzhiyun	min: Below this number of pages UDP is not bothered about its
941*4882a593Smuzhiyun	memory appetite. When amount of memory allocated by UDP exceeds
942*4882a593Smuzhiyun	this number, UDP starts to moderate memory usage.
943*4882a593Smuzhiyun
944*4882a593Smuzhiyun	pressure: This value was introduced to follow format of tcp_mem.
945*4882a593Smuzhiyun
946*4882a593Smuzhiyun	max: Number of pages allowed for queueing by all UDP sockets.
947*4882a593Smuzhiyun
948*4882a593Smuzhiyun	Default is calculated at boot time from amount of available memory.
949*4882a593Smuzhiyun
950*4882a593Smuzhiyunudp_rmem_min - INTEGER
951*4882a593Smuzhiyun	Minimal size of receive buffer used by UDP sockets in moderation.
952*4882a593Smuzhiyun	Each UDP socket is able to use the size for receiving data, even if
953*4882a593Smuzhiyun	total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
954*4882a593Smuzhiyun
955*4882a593Smuzhiyun	Default: 4K
956*4882a593Smuzhiyun
957*4882a593Smuzhiyunudp_wmem_min - INTEGER
958*4882a593Smuzhiyun	Minimal size of send buffer used by UDP sockets in moderation.
959*4882a593Smuzhiyun	Each UDP socket is able to use the size for sending data, even if
960*4882a593Smuzhiyun	total pages of UDP sockets exceed udp_mem pressure. The unit is byte.
961*4882a593Smuzhiyun
962*4882a593Smuzhiyun	Default: 4K
963*4882a593Smuzhiyun
964*4882a593SmuzhiyunRAW variables
965*4882a593Smuzhiyun=============
966*4882a593Smuzhiyun
967*4882a593Smuzhiyunraw_l3mdev_accept - BOOLEAN
968*4882a593Smuzhiyun	Enabling this option allows a "global" bound socket to work
969*4882a593Smuzhiyun	across L3 master domains (e.g., VRFs) with packets capable of
970*4882a593Smuzhiyun	being received regardless of the L3 domain in which they
971*4882a593Smuzhiyun	originated. Only valid when the kernel was compiled with
972*4882a593Smuzhiyun	CONFIG_NET_L3_MASTER_DEV.
973*4882a593Smuzhiyun
974*4882a593Smuzhiyun	Default: 1 (enabled)
975*4882a593Smuzhiyun
976*4882a593SmuzhiyunCIPSOv4 Variables
977*4882a593Smuzhiyun=================
978*4882a593Smuzhiyun
979*4882a593Smuzhiyuncipso_cache_enable - BOOLEAN
980*4882a593Smuzhiyun	If set, enable additions to and lookups from the CIPSO label mapping
981*4882a593Smuzhiyun	cache.  If unset, additions are ignored and lookups always result in a
982*4882a593Smuzhiyun	miss.  However, regardless of the setting the cache is still
983*4882a593Smuzhiyun	invalidated when required when means you can safely toggle this on and
984*4882a593Smuzhiyun	off and the cache will always be "safe".
985*4882a593Smuzhiyun
986*4882a593Smuzhiyun	Default: 1
987*4882a593Smuzhiyun
988*4882a593Smuzhiyuncipso_cache_bucket_size - INTEGER
989*4882a593Smuzhiyun	The CIPSO label cache consists of a fixed size hash table with each
990*4882a593Smuzhiyun	hash bucket containing a number of cache entries.  This variable limits
991*4882a593Smuzhiyun	the number of entries in each hash bucket; the larger the value is, the
992*4882a593Smuzhiyun	more CIPSO label mappings that can be cached.  When the number of
993*4882a593Smuzhiyun	entries in a given hash bucket reaches this limit adding new entries
994*4882a593Smuzhiyun	causes the oldest entry in the bucket to be removed to make room.
995*4882a593Smuzhiyun
996*4882a593Smuzhiyun	Default: 10
997*4882a593Smuzhiyun
998*4882a593Smuzhiyuncipso_rbm_optfmt - BOOLEAN
999*4882a593Smuzhiyun	Enable the "Optimized Tag 1 Format" as defined in section 3.4.2.6 of
1000*4882a593Smuzhiyun	the CIPSO draft specification (see Documentation/netlabel for details).
1001*4882a593Smuzhiyun	This means that when set the CIPSO tag will be padded with empty
1002*4882a593Smuzhiyun	categories in order to make the packet data 32-bit aligned.
1003*4882a593Smuzhiyun
1004*4882a593Smuzhiyun	Default: 0
1005*4882a593Smuzhiyun
1006*4882a593Smuzhiyuncipso_rbm_structvalid - BOOLEAN
1007*4882a593Smuzhiyun	If set, do a very strict check of the CIPSO option when
1008*4882a593Smuzhiyun	ip_options_compile() is called.  If unset, relax the checks done during
1009*4882a593Smuzhiyun	ip_options_compile().  Either way is "safe" as errors are caught else
1010*4882a593Smuzhiyun	where in the CIPSO processing code but setting this to 0 (False) should
1011*4882a593Smuzhiyun	result in less work (i.e. it should be faster) but could cause problems
1012*4882a593Smuzhiyun	with other implementations that require strict checking.
1013*4882a593Smuzhiyun
1014*4882a593Smuzhiyun	Default: 0
1015*4882a593Smuzhiyun
1016*4882a593SmuzhiyunIP Variables
1017*4882a593Smuzhiyun============
1018*4882a593Smuzhiyun
1019*4882a593Smuzhiyunip_local_port_range - 2 INTEGERS
1020*4882a593Smuzhiyun	Defines the local port range that is used by TCP and UDP to
1021*4882a593Smuzhiyun	choose the local port. The first number is the first, the
1022*4882a593Smuzhiyun	second the last local port number.
1023*4882a593Smuzhiyun	If possible, it is better these numbers have different parity
1024*4882a593Smuzhiyun	(one even and one odd value).
1025*4882a593Smuzhiyun	Must be greater than or equal to ip_unprivileged_port_start.
1026*4882a593Smuzhiyun	The default values are 32768 and 60999 respectively.
1027*4882a593Smuzhiyun
1028*4882a593Smuzhiyunip_local_reserved_ports - list of comma separated ranges
1029*4882a593Smuzhiyun	Specify the ports which are reserved for known third-party
1030*4882a593Smuzhiyun	applications. These ports will not be used by automatic port
1031*4882a593Smuzhiyun	assignments (e.g. when calling connect() or bind() with port
1032*4882a593Smuzhiyun	number 0). Explicit port allocation behavior is unchanged.
1033*4882a593Smuzhiyun
1034*4882a593Smuzhiyun	The format used for both input and output is a comma separated
1035*4882a593Smuzhiyun	list of ranges (e.g. "1,2-4,10-10" for ports 1, 2, 3, 4 and
1036*4882a593Smuzhiyun	10). Writing to the file will clear all previously reserved
1037*4882a593Smuzhiyun	ports and update the current list with the one given in the
1038*4882a593Smuzhiyun	input.
1039*4882a593Smuzhiyun
1040*4882a593Smuzhiyun	Note that ip_local_port_range and ip_local_reserved_ports
1041*4882a593Smuzhiyun	settings are independent and both are considered by the kernel
1042*4882a593Smuzhiyun	when determining which ports are available for automatic port
1043*4882a593Smuzhiyun	assignments.
1044*4882a593Smuzhiyun
1045*4882a593Smuzhiyun	You can reserve ports which are not in the current
1046*4882a593Smuzhiyun	ip_local_port_range, e.g.::
1047*4882a593Smuzhiyun
1048*4882a593Smuzhiyun	    $ cat /proc/sys/net/ipv4/ip_local_port_range
1049*4882a593Smuzhiyun	    32000	60999
1050*4882a593Smuzhiyun	    $ cat /proc/sys/net/ipv4/ip_local_reserved_ports
1051*4882a593Smuzhiyun	    8080,9148
1052*4882a593Smuzhiyun
1053*4882a593Smuzhiyun	although this is redundant. However such a setting is useful
1054*4882a593Smuzhiyun	if later the port range is changed to a value that will
1055*4882a593Smuzhiyun	include the reserved ports.
1056*4882a593Smuzhiyun
1057*4882a593Smuzhiyun	Default: Empty
1058*4882a593Smuzhiyun
1059*4882a593Smuzhiyunip_local_unbindable_ports - list of comma separated ranges
1060*4882a593Smuzhiyun	Specify the ports which are not directly bind()able.
1061*4882a593Smuzhiyun
1062*4882a593Smuzhiyun	Usually you would use this to block the use of ports which
1063*4882a593Smuzhiyun	are invalid due to something outside of the control of the
1064*4882a593Smuzhiyun	kernel.  For example a port stolen by the nic for serial
1065*4882a593Smuzhiyun	console, remote power management or debugging.
1066*4882a593Smuzhiyun
1067*4882a593Smuzhiyun	There's a relatively high chance you will also want to list
1068*4882a593Smuzhiyun	these ports in 'ip_local_reserved_ports' to prevent autobinding.
1069*4882a593Smuzhiyun
1070*4882a593Smuzhiyun	Default: Empty
1071*4882a593Smuzhiyun
1072*4882a593Smuzhiyunip_unprivileged_port_start - INTEGER
1073*4882a593Smuzhiyun	This is a per-namespace sysctl.  It defines the first
1074*4882a593Smuzhiyun	unprivileged port in the network namespace.  Privileged ports
1075*4882a593Smuzhiyun	require root or CAP_NET_BIND_SERVICE in order to bind to them.
1076*4882a593Smuzhiyun	To disable all privileged ports, set this to 0.  They must not
1077*4882a593Smuzhiyun	overlap with the ip_local_port_range.
1078*4882a593Smuzhiyun
1079*4882a593Smuzhiyun	Default: 1024
1080*4882a593Smuzhiyun
1081*4882a593Smuzhiyunip_nonlocal_bind - BOOLEAN
1082*4882a593Smuzhiyun	If set, allows processes to bind() to non-local IP addresses,
1083*4882a593Smuzhiyun	which can be quite useful - but may break some applications.
1084*4882a593Smuzhiyun
1085*4882a593Smuzhiyun	Default: 0
1086*4882a593Smuzhiyun
1087*4882a593Smuzhiyunip_autobind_reuse - BOOLEAN
1088*4882a593Smuzhiyun	By default, bind() does not select the ports automatically even if
1089*4882a593Smuzhiyun	the new socket and all sockets bound to the port have SO_REUSEADDR.
1090*4882a593Smuzhiyun	ip_autobind_reuse allows bind() to reuse the port and this is useful
1091*4882a593Smuzhiyun	when you use bind()+connect(), but may break some applications.
1092*4882a593Smuzhiyun	The preferred solution is to use IP_BIND_ADDRESS_NO_PORT and this
1093*4882a593Smuzhiyun	option should only be set by experts.
1094*4882a593Smuzhiyun	Default: 0
1095*4882a593Smuzhiyun
1096*4882a593Smuzhiyunip_dynaddr - INTEGER
1097*4882a593Smuzhiyun	If set non-zero, enables support for dynamic addresses.
1098*4882a593Smuzhiyun	If set to a non-zero value larger than 1, a kernel log
1099*4882a593Smuzhiyun	message will be printed when dynamic address rewriting
1100*4882a593Smuzhiyun	occurs.
1101*4882a593Smuzhiyun
1102*4882a593Smuzhiyun	Default: 0
1103*4882a593Smuzhiyun
1104*4882a593Smuzhiyunip_early_demux - BOOLEAN
1105*4882a593Smuzhiyun	Optimize input packet processing down to one demux for
1106*4882a593Smuzhiyun	certain kinds of local sockets.  Currently we only do this
1107*4882a593Smuzhiyun	for established TCP and connected UDP sockets.
1108*4882a593Smuzhiyun
1109*4882a593Smuzhiyun	It may add an additional cost for pure routing workloads that
1110*4882a593Smuzhiyun	reduces overall throughput, in such case you should disable it.
1111*4882a593Smuzhiyun
1112*4882a593Smuzhiyun	Default: 1
1113*4882a593Smuzhiyun
1114*4882a593Smuzhiyunping_group_range - 2 INTEGERS
1115*4882a593Smuzhiyun	Restrict ICMP_PROTO datagram sockets to users in the group range.
1116*4882a593Smuzhiyun	The default is "1 0", meaning, that nobody (not even root) may
1117*4882a593Smuzhiyun	create ping sockets.  Setting it to "100 100" would grant permissions
1118*4882a593Smuzhiyun	to the single group. "0 4294967295" would enable it for the world, "100
1119*4882a593Smuzhiyun	4294967295" would enable it for the users, but not daemons.
1120*4882a593Smuzhiyun
1121*4882a593Smuzhiyuntcp_early_demux - BOOLEAN
1122*4882a593Smuzhiyun	Enable early demux for established TCP sockets.
1123*4882a593Smuzhiyun
1124*4882a593Smuzhiyun	Default: 1
1125*4882a593Smuzhiyun
1126*4882a593Smuzhiyunudp_early_demux - BOOLEAN
1127*4882a593Smuzhiyun	Enable early demux for connected UDP sockets. Disable this if
1128*4882a593Smuzhiyun	your system could experience more unconnected load.
1129*4882a593Smuzhiyun
1130*4882a593Smuzhiyun	Default: 1
1131*4882a593Smuzhiyun
1132*4882a593Smuzhiyunicmp_echo_ignore_all - BOOLEAN
1133*4882a593Smuzhiyun	If set non-zero, then the kernel will ignore all ICMP ECHO
1134*4882a593Smuzhiyun	requests sent to it.
1135*4882a593Smuzhiyun
1136*4882a593Smuzhiyun	Default: 0
1137*4882a593Smuzhiyun
1138*4882a593Smuzhiyunicmp_echo_ignore_broadcasts - BOOLEAN
1139*4882a593Smuzhiyun	If set non-zero, then the kernel will ignore all ICMP ECHO and
1140*4882a593Smuzhiyun	TIMESTAMP requests sent to it via broadcast/multicast.
1141*4882a593Smuzhiyun
1142*4882a593Smuzhiyun	Default: 1
1143*4882a593Smuzhiyun
1144*4882a593Smuzhiyunicmp_ratelimit - INTEGER
1145*4882a593Smuzhiyun	Limit the maximal rates for sending ICMP packets whose type matches
1146*4882a593Smuzhiyun	icmp_ratemask (see below) to specific targets.
1147*4882a593Smuzhiyun	0 to disable any limiting,
1148*4882a593Smuzhiyun	otherwise the minimal space between responses in milliseconds.
1149*4882a593Smuzhiyun	Note that another sysctl, icmp_msgs_per_sec limits the number
1150*4882a593Smuzhiyun	of ICMP packets	sent on all targets.
1151*4882a593Smuzhiyun
1152*4882a593Smuzhiyun	Default: 1000
1153*4882a593Smuzhiyun
1154*4882a593Smuzhiyunicmp_msgs_per_sec - INTEGER
1155*4882a593Smuzhiyun	Limit maximal number of ICMP packets sent per second from this host.
1156*4882a593Smuzhiyun	Only messages whose type matches icmp_ratemask (see below) are
1157*4882a593Smuzhiyun	controlled by this limit. For security reasons, the precise count
1158*4882a593Smuzhiyun	of messages per second is randomized.
1159*4882a593Smuzhiyun
1160*4882a593Smuzhiyun	Default: 1000
1161*4882a593Smuzhiyun
1162*4882a593Smuzhiyunicmp_msgs_burst - INTEGER
1163*4882a593Smuzhiyun	icmp_msgs_per_sec controls number of ICMP packets sent per second,
1164*4882a593Smuzhiyun	while icmp_msgs_burst controls the burst size of these packets.
1165*4882a593Smuzhiyun	For security reasons, the precise burst size is randomized.
1166*4882a593Smuzhiyun
1167*4882a593Smuzhiyun	Default: 50
1168*4882a593Smuzhiyun
1169*4882a593Smuzhiyunicmp_ratemask - INTEGER
1170*4882a593Smuzhiyun	Mask made of ICMP types for which rates are being limited.
1171*4882a593Smuzhiyun
1172*4882a593Smuzhiyun	Significant bits: IHGFEDCBA9876543210
1173*4882a593Smuzhiyun
1174*4882a593Smuzhiyun	Default mask:     0000001100000011000 (6168)
1175*4882a593Smuzhiyun
1176*4882a593Smuzhiyun	Bit definitions (see include/linux/icmp.h):
1177*4882a593Smuzhiyun
1178*4882a593Smuzhiyun		= =========================
1179*4882a593Smuzhiyun		0 Echo Reply
1180*4882a593Smuzhiyun		3 Destination Unreachable [1]_
1181*4882a593Smuzhiyun		4 Source Quench [1]_
1182*4882a593Smuzhiyun		5 Redirect
1183*4882a593Smuzhiyun		8 Echo Request
1184*4882a593Smuzhiyun		B Time Exceeded [1]_
1185*4882a593Smuzhiyun		C Parameter Problem [1]_
1186*4882a593Smuzhiyun		D Timestamp Request
1187*4882a593Smuzhiyun		E Timestamp Reply
1188*4882a593Smuzhiyun		F Info Request
1189*4882a593Smuzhiyun		G Info Reply
1190*4882a593Smuzhiyun		H Address Mask Request
1191*4882a593Smuzhiyun		I Address Mask Reply
1192*4882a593Smuzhiyun		= =========================
1193*4882a593Smuzhiyun
1194*4882a593Smuzhiyun	.. [1] These are rate limited by default (see default mask above)
1195*4882a593Smuzhiyun
1196*4882a593Smuzhiyunicmp_ignore_bogus_error_responses - BOOLEAN
1197*4882a593Smuzhiyun	Some routers violate RFC1122 by sending bogus responses to broadcast
1198*4882a593Smuzhiyun	frames.  Such violations are normally logged via a kernel warning.
1199*4882a593Smuzhiyun	If this is set to TRUE, the kernel will not give such warnings, which
1200*4882a593Smuzhiyun	will avoid log file clutter.
1201*4882a593Smuzhiyun
1202*4882a593Smuzhiyun	Default: 1
1203*4882a593Smuzhiyun
1204*4882a593Smuzhiyunicmp_errors_use_inbound_ifaddr - BOOLEAN
1205*4882a593Smuzhiyun
1206*4882a593Smuzhiyun	If zero, icmp error messages are sent with the primary address of
1207*4882a593Smuzhiyun	the exiting interface.
1208*4882a593Smuzhiyun
1209*4882a593Smuzhiyun	If non-zero, the message will be sent with the primary address of
1210*4882a593Smuzhiyun	the interface that received the packet that caused the icmp error.
1211*4882a593Smuzhiyun	This is the behaviour network many administrators will expect from
1212*4882a593Smuzhiyun	a router. And it can make debugging complicated network layouts
1213*4882a593Smuzhiyun	much easier.
1214*4882a593Smuzhiyun
1215*4882a593Smuzhiyun	Note that if no primary address exists for the interface selected,
1216*4882a593Smuzhiyun	then the primary address of the first non-loopback interface that
1217*4882a593Smuzhiyun	has one will be used regardless of this setting.
1218*4882a593Smuzhiyun
1219*4882a593Smuzhiyun	Default: 0
1220*4882a593Smuzhiyun
1221*4882a593Smuzhiyunigmp_max_memberships - INTEGER
1222*4882a593Smuzhiyun	Change the maximum number of multicast groups we can subscribe to.
1223*4882a593Smuzhiyun	Default: 20
1224*4882a593Smuzhiyun
1225*4882a593Smuzhiyun	Theoretical maximum value is bounded by having to send a membership
1226*4882a593Smuzhiyun	report in a single datagram (i.e. the report can't span multiple
1227*4882a593Smuzhiyun	datagrams, or risk confusing the switch and leaving groups you don't
1228*4882a593Smuzhiyun	intend to).
1229*4882a593Smuzhiyun
1230*4882a593Smuzhiyun	The number of supported groups 'M' is bounded by the number of group
1231*4882a593Smuzhiyun	report entries you can fit into a single datagram of 65535 bytes.
1232*4882a593Smuzhiyun
1233*4882a593Smuzhiyun	M = 65536-sizeof (ip header)/(sizeof(Group record))
1234*4882a593Smuzhiyun
1235*4882a593Smuzhiyun	Group records are variable length, with a minimum of 12 bytes.
1236*4882a593Smuzhiyun	So net.ipv4.igmp_max_memberships should not be set higher than:
1237*4882a593Smuzhiyun
1238*4882a593Smuzhiyun	(65536-24) / 12 = 5459
1239*4882a593Smuzhiyun
1240*4882a593Smuzhiyun	The value 5459 assumes no IP header options, so in practice
1241*4882a593Smuzhiyun	this number may be lower.
1242*4882a593Smuzhiyun
1243*4882a593Smuzhiyunigmp_max_msf - INTEGER
1244*4882a593Smuzhiyun	Maximum number of addresses allowed in the source filter list for a
1245*4882a593Smuzhiyun	multicast group.
1246*4882a593Smuzhiyun
1247*4882a593Smuzhiyun	Default: 10
1248*4882a593Smuzhiyun
1249*4882a593Smuzhiyunigmp_qrv - INTEGER
1250*4882a593Smuzhiyun	Controls the IGMP query robustness variable (see RFC2236 8.1).
1251*4882a593Smuzhiyun
1252*4882a593Smuzhiyun	Default: 2 (as specified by RFC2236 8.1)
1253*4882a593Smuzhiyun
1254*4882a593Smuzhiyun	Minimum: 1 (as specified by RFC6636 4.5)
1255*4882a593Smuzhiyun
1256*4882a593Smuzhiyunforce_igmp_version - INTEGER
1257*4882a593Smuzhiyun	- 0 - (default) No enforcement of a IGMP version, IGMPv1/v2 fallback
1258*4882a593Smuzhiyun	  allowed. Will back to IGMPv3 mode again if all IGMPv1/v2 Querier
1259*4882a593Smuzhiyun	  Present timer expires.
1260*4882a593Smuzhiyun	- 1 - Enforce to use IGMP version 1. Will also reply IGMPv1 report if
1261*4882a593Smuzhiyun	  receive IGMPv2/v3 query.
1262*4882a593Smuzhiyun	- 2 - Enforce to use IGMP version 2. Will fallback to IGMPv1 if receive
1263*4882a593Smuzhiyun	  IGMPv1 query message. Will reply report if receive IGMPv3 query.
1264*4882a593Smuzhiyun	- 3 - Enforce to use IGMP version 3. The same react with default 0.
1265*4882a593Smuzhiyun
1266*4882a593Smuzhiyun	.. note::
1267*4882a593Smuzhiyun
1268*4882a593Smuzhiyun	   this is not the same with force_mld_version because IGMPv3 RFC3376
1269*4882a593Smuzhiyun	   Security Considerations does not have clear description that we could
1270*4882a593Smuzhiyun	   ignore other version messages completely as MLDv2 RFC3810. So make
1271*4882a593Smuzhiyun	   this value as default 0 is recommended.
1272*4882a593Smuzhiyun
1273*4882a593Smuzhiyun``conf/interface/*``
1274*4882a593Smuzhiyun	changes special settings per interface (where
1275*4882a593Smuzhiyun	interface" is the name of your network interface)
1276*4882a593Smuzhiyun
1277*4882a593Smuzhiyun``conf/all/*``
1278*4882a593Smuzhiyun	  is special, changes the settings for all interfaces
1279*4882a593Smuzhiyun
1280*4882a593Smuzhiyunlog_martians - BOOLEAN
1281*4882a593Smuzhiyun	Log packets with impossible addresses to kernel log.
1282*4882a593Smuzhiyun	log_martians for the interface will be enabled if at least one of
1283*4882a593Smuzhiyun	conf/{all,interface}/log_martians is set to TRUE,
1284*4882a593Smuzhiyun	it will be disabled otherwise
1285*4882a593Smuzhiyun
1286*4882a593Smuzhiyunaccept_redirects - BOOLEAN
1287*4882a593Smuzhiyun	Accept ICMP redirect messages.
1288*4882a593Smuzhiyun	accept_redirects for the interface will be enabled if:
1289*4882a593Smuzhiyun
1290*4882a593Smuzhiyun	- both conf/{all,interface}/accept_redirects are TRUE in the case
1291*4882a593Smuzhiyun	  forwarding for the interface is enabled
1292*4882a593Smuzhiyun
1293*4882a593Smuzhiyun	or
1294*4882a593Smuzhiyun
1295*4882a593Smuzhiyun	- at least one of conf/{all,interface}/accept_redirects is TRUE in the
1296*4882a593Smuzhiyun	  case forwarding for the interface is disabled
1297*4882a593Smuzhiyun
1298*4882a593Smuzhiyun	accept_redirects for the interface will be disabled otherwise
1299*4882a593Smuzhiyun
1300*4882a593Smuzhiyun	default:
1301*4882a593Smuzhiyun
1302*4882a593Smuzhiyun		- TRUE (host)
1303*4882a593Smuzhiyun		- FALSE (router)
1304*4882a593Smuzhiyun
1305*4882a593Smuzhiyunforwarding - BOOLEAN
1306*4882a593Smuzhiyun	Enable IP forwarding on this interface.  This controls whether packets
1307*4882a593Smuzhiyun	received _on_ this interface can be forwarded.
1308*4882a593Smuzhiyun
1309*4882a593Smuzhiyunmc_forwarding - BOOLEAN
1310*4882a593Smuzhiyun	Do multicast routing. The kernel needs to be compiled with CONFIG_MROUTE
1311*4882a593Smuzhiyun	and a multicast routing daemon is required.
1312*4882a593Smuzhiyun	conf/all/mc_forwarding must also be set to TRUE to enable multicast
1313*4882a593Smuzhiyun	routing	for the interface
1314*4882a593Smuzhiyun
1315*4882a593Smuzhiyunmedium_id - INTEGER
1316*4882a593Smuzhiyun	Integer value used to differentiate the devices by the medium they
1317*4882a593Smuzhiyun	are attached to. Two devices can have different id values when
1318*4882a593Smuzhiyun	the broadcast packets are received only on one of them.
1319*4882a593Smuzhiyun	The default value 0 means that the device is the only interface
1320*4882a593Smuzhiyun	to its medium, value of -1 means that medium is not known.
1321*4882a593Smuzhiyun
1322*4882a593Smuzhiyun	Currently, it is used to change the proxy_arp behavior:
1323*4882a593Smuzhiyun	the proxy_arp feature is enabled for packets forwarded between
1324*4882a593Smuzhiyun	two devices attached to different media.
1325*4882a593Smuzhiyun
1326*4882a593Smuzhiyunproxy_arp - BOOLEAN
1327*4882a593Smuzhiyun	Do proxy arp.
1328*4882a593Smuzhiyun
1329*4882a593Smuzhiyun	proxy_arp for the interface will be enabled if at least one of
1330*4882a593Smuzhiyun	conf/{all,interface}/proxy_arp is set to TRUE,
1331*4882a593Smuzhiyun	it will be disabled otherwise
1332*4882a593Smuzhiyun
1333*4882a593Smuzhiyunproxy_arp_pvlan - BOOLEAN
1334*4882a593Smuzhiyun	Private VLAN proxy arp.
1335*4882a593Smuzhiyun
1336*4882a593Smuzhiyun	Basically allow proxy arp replies back to the same interface
1337*4882a593Smuzhiyun	(from which the ARP request/solicitation was received).
1338*4882a593Smuzhiyun
1339*4882a593Smuzhiyun	This is done to support (ethernet) switch features, like RFC
1340*4882a593Smuzhiyun	3069, where the individual ports are NOT allowed to
1341*4882a593Smuzhiyun	communicate with each other, but they are allowed to talk to
1342*4882a593Smuzhiyun	the upstream router.  As described in RFC 3069, it is possible
1343*4882a593Smuzhiyun	to allow these hosts to communicate through the upstream
1344*4882a593Smuzhiyun	router by proxy_arp'ing. Don't need to be used together with
1345*4882a593Smuzhiyun	proxy_arp.
1346*4882a593Smuzhiyun
1347*4882a593Smuzhiyun	This technology is known by different names:
1348*4882a593Smuzhiyun
1349*4882a593Smuzhiyun	  In RFC 3069 it is called VLAN Aggregation.
1350*4882a593Smuzhiyun	  Cisco and Allied Telesyn call it Private VLAN.
1351*4882a593Smuzhiyun	  Hewlett-Packard call it Source-Port filtering or port-isolation.
1352*4882a593Smuzhiyun	  Ericsson call it MAC-Forced Forwarding (RFC Draft).
1353*4882a593Smuzhiyun
1354*4882a593Smuzhiyunshared_media - BOOLEAN
1355*4882a593Smuzhiyun	Send(router) or accept(host) RFC1620 shared media redirects.
1356*4882a593Smuzhiyun	Overrides secure_redirects.
1357*4882a593Smuzhiyun
1358*4882a593Smuzhiyun	shared_media for the interface will be enabled if at least one of
1359*4882a593Smuzhiyun	conf/{all,interface}/shared_media is set to TRUE,
1360*4882a593Smuzhiyun	it will be disabled otherwise
1361*4882a593Smuzhiyun
1362*4882a593Smuzhiyun	default TRUE
1363*4882a593Smuzhiyun
1364*4882a593Smuzhiyunsecure_redirects - BOOLEAN
1365*4882a593Smuzhiyun	Accept ICMP redirect messages only to gateways listed in the
1366*4882a593Smuzhiyun	interface's current gateway list. Even if disabled, RFC1122 redirect
1367*4882a593Smuzhiyun	rules still apply.
1368*4882a593Smuzhiyun
1369*4882a593Smuzhiyun	Overridden by shared_media.
1370*4882a593Smuzhiyun
1371*4882a593Smuzhiyun	secure_redirects for the interface will be enabled if at least one of
1372*4882a593Smuzhiyun	conf/{all,interface}/secure_redirects is set to TRUE,
1373*4882a593Smuzhiyun	it will be disabled otherwise
1374*4882a593Smuzhiyun
1375*4882a593Smuzhiyun	default TRUE
1376*4882a593Smuzhiyun
1377*4882a593Smuzhiyunsend_redirects - BOOLEAN
1378*4882a593Smuzhiyun	Send redirects, if router.
1379*4882a593Smuzhiyun
1380*4882a593Smuzhiyun	send_redirects for the interface will be enabled if at least one of
1381*4882a593Smuzhiyun	conf/{all,interface}/send_redirects is set to TRUE,
1382*4882a593Smuzhiyun	it will be disabled otherwise
1383*4882a593Smuzhiyun
1384*4882a593Smuzhiyun	Default: TRUE
1385*4882a593Smuzhiyun
1386*4882a593Smuzhiyunbootp_relay - BOOLEAN
1387*4882a593Smuzhiyun	Accept packets with source address 0.b.c.d destined
1388*4882a593Smuzhiyun	not to this host as local ones. It is supposed, that
1389*4882a593Smuzhiyun	BOOTP relay daemon will catch and forward such packets.
1390*4882a593Smuzhiyun	conf/all/bootp_relay must also be set to TRUE to enable BOOTP relay
1391*4882a593Smuzhiyun	for the interface
1392*4882a593Smuzhiyun
1393*4882a593Smuzhiyun	default FALSE
1394*4882a593Smuzhiyun
1395*4882a593Smuzhiyun	Not Implemented Yet.
1396*4882a593Smuzhiyun
1397*4882a593Smuzhiyunaccept_source_route - BOOLEAN
1398*4882a593Smuzhiyun	Accept packets with SRR option.
1399*4882a593Smuzhiyun	conf/all/accept_source_route must also be set to TRUE to accept packets
1400*4882a593Smuzhiyun	with SRR option on the interface
1401*4882a593Smuzhiyun
1402*4882a593Smuzhiyun	default
1403*4882a593Smuzhiyun
1404*4882a593Smuzhiyun		- TRUE (router)
1405*4882a593Smuzhiyun		- FALSE (host)
1406*4882a593Smuzhiyun
1407*4882a593Smuzhiyunaccept_local - BOOLEAN
1408*4882a593Smuzhiyun	Accept packets with local source addresses. In combination with
1409*4882a593Smuzhiyun	suitable routing, this can be used to direct packets between two
1410*4882a593Smuzhiyun	local interfaces over the wire and have them accepted properly.
1411*4882a593Smuzhiyun	default FALSE
1412*4882a593Smuzhiyun
1413*4882a593Smuzhiyunroute_localnet - BOOLEAN
1414*4882a593Smuzhiyun	Do not consider loopback addresses as martian source or destination
1415*4882a593Smuzhiyun	while routing. This enables the use of 127/8 for local routing purposes.
1416*4882a593Smuzhiyun
1417*4882a593Smuzhiyun	default FALSE
1418*4882a593Smuzhiyun
1419*4882a593Smuzhiyunrp_filter - INTEGER
1420*4882a593Smuzhiyun	- 0 - No source validation.
1421*4882a593Smuzhiyun	- 1 - Strict mode as defined in RFC3704 Strict Reverse Path
1422*4882a593Smuzhiyun	  Each incoming packet is tested against the FIB and if the interface
1423*4882a593Smuzhiyun	  is not the best reverse path the packet check will fail.
1424*4882a593Smuzhiyun	  By default failed packets are discarded.
1425*4882a593Smuzhiyun	- 2 - Loose mode as defined in RFC3704 Loose Reverse Path
1426*4882a593Smuzhiyun	  Each incoming packet's source address is also tested against the FIB
1427*4882a593Smuzhiyun	  and if the source address is not reachable via any interface
1428*4882a593Smuzhiyun	  the packet check will fail.
1429*4882a593Smuzhiyun
1430*4882a593Smuzhiyun	Current recommended practice in RFC3704 is to enable strict mode
1431*4882a593Smuzhiyun	to prevent IP spoofing from DDos attacks. If using asymmetric routing
1432*4882a593Smuzhiyun	or other complicated routing, then loose mode is recommended.
1433*4882a593Smuzhiyun
1434*4882a593Smuzhiyun	The max value from conf/{all,interface}/rp_filter is used
1435*4882a593Smuzhiyun	when doing source validation on the {interface}.
1436*4882a593Smuzhiyun
1437*4882a593Smuzhiyun	Default value is 0. Note that some distributions enable it
1438*4882a593Smuzhiyun	in startup scripts.
1439*4882a593Smuzhiyun
1440*4882a593Smuzhiyunarp_filter - BOOLEAN
1441*4882a593Smuzhiyun	- 1 - Allows you to have multiple network interfaces on the same
1442*4882a593Smuzhiyun	  subnet, and have the ARPs for each interface be answered
1443*4882a593Smuzhiyun	  based on whether or not the kernel would route a packet from
1444*4882a593Smuzhiyun	  the ARP'd IP out that interface (therefore you must use source
1445*4882a593Smuzhiyun	  based routing for this to work). In other words it allows control
1446*4882a593Smuzhiyun	  of which cards (usually 1) will respond to an arp request.
1447*4882a593Smuzhiyun
1448*4882a593Smuzhiyun	- 0 - (default) The kernel can respond to arp requests with addresses
1449*4882a593Smuzhiyun	  from other interfaces. This may seem wrong but it usually makes
1450*4882a593Smuzhiyun	  sense, because it increases the chance of successful communication.
1451*4882a593Smuzhiyun	  IP addresses are owned by the complete host on Linux, not by
1452*4882a593Smuzhiyun	  particular interfaces. Only for more complex setups like load-
1453*4882a593Smuzhiyun	  balancing, does this behaviour cause problems.
1454*4882a593Smuzhiyun
1455*4882a593Smuzhiyun	arp_filter for the interface will be enabled if at least one of
1456*4882a593Smuzhiyun	conf/{all,interface}/arp_filter is set to TRUE,
1457*4882a593Smuzhiyun	it will be disabled otherwise
1458*4882a593Smuzhiyun
1459*4882a593Smuzhiyunarp_announce - INTEGER
1460*4882a593Smuzhiyun	Define different restriction levels for announcing the local
1461*4882a593Smuzhiyun	source IP address from IP packets in ARP requests sent on
1462*4882a593Smuzhiyun	interface:
1463*4882a593Smuzhiyun
1464*4882a593Smuzhiyun	- 0 - (default) Use any local address, configured on any interface
1465*4882a593Smuzhiyun	- 1 - Try to avoid local addresses that are not in the target's
1466*4882a593Smuzhiyun	  subnet for this interface. This mode is useful when target
1467*4882a593Smuzhiyun	  hosts reachable via this interface require the source IP
1468*4882a593Smuzhiyun	  address in ARP requests to be part of their logical network
1469*4882a593Smuzhiyun	  configured on the receiving interface. When we generate the
1470*4882a593Smuzhiyun	  request we will check all our subnets that include the
1471*4882a593Smuzhiyun	  target IP and will preserve the source address if it is from
1472*4882a593Smuzhiyun	  such subnet. If there is no such subnet we select source
1473*4882a593Smuzhiyun	  address according to the rules for level 2.
1474*4882a593Smuzhiyun	- 2 - Always use the best local address for this target.
1475*4882a593Smuzhiyun	  In this mode we ignore the source address in the IP packet
1476*4882a593Smuzhiyun	  and try to select local address that we prefer for talks with
1477*4882a593Smuzhiyun	  the target host. Such local address is selected by looking
1478*4882a593Smuzhiyun	  for primary IP addresses on all our subnets on the outgoing
1479*4882a593Smuzhiyun	  interface that include the target IP address. If no suitable
1480*4882a593Smuzhiyun	  local address is found we select the first local address
1481*4882a593Smuzhiyun	  we have on the outgoing interface or on all other interfaces,
1482*4882a593Smuzhiyun	  with the hope we will receive reply for our request and
1483*4882a593Smuzhiyun	  even sometimes no matter the source IP address we announce.
1484*4882a593Smuzhiyun
1485*4882a593Smuzhiyun	The max value from conf/{all,interface}/arp_announce is used.
1486*4882a593Smuzhiyun
1487*4882a593Smuzhiyun	Increasing the restriction level gives more chance for
1488*4882a593Smuzhiyun	receiving answer from the resolved target while decreasing
1489*4882a593Smuzhiyun	the level announces more valid sender's information.
1490*4882a593Smuzhiyun
1491*4882a593Smuzhiyunarp_ignore - INTEGER
1492*4882a593Smuzhiyun	Define different modes for sending replies in response to
1493*4882a593Smuzhiyun	received ARP requests that resolve local target IP addresses:
1494*4882a593Smuzhiyun
1495*4882a593Smuzhiyun	- 0 - (default): reply for any local target IP address, configured
1496*4882a593Smuzhiyun	  on any interface
1497*4882a593Smuzhiyun	- 1 - reply only if the target IP address is local address
1498*4882a593Smuzhiyun	  configured on the incoming interface
1499*4882a593Smuzhiyun	- 2 - reply only if the target IP address is local address
1500*4882a593Smuzhiyun	  configured on the incoming interface and both with the
1501*4882a593Smuzhiyun	  sender's IP address are part from same subnet on this interface
1502*4882a593Smuzhiyun	- 3 - do not reply for local addresses configured with scope host,
1503*4882a593Smuzhiyun	  only resolutions for global and link addresses are replied
1504*4882a593Smuzhiyun	- 4-7 - reserved
1505*4882a593Smuzhiyun	- 8 - do not reply for all local addresses
1506*4882a593Smuzhiyun
1507*4882a593Smuzhiyun	The max value from conf/{all,interface}/arp_ignore is used
1508*4882a593Smuzhiyun	when ARP request is received on the {interface}
1509*4882a593Smuzhiyun
1510*4882a593Smuzhiyunarp_notify - BOOLEAN
1511*4882a593Smuzhiyun	Define mode for notification of address and device changes.
1512*4882a593Smuzhiyun
1513*4882a593Smuzhiyun	 ==  ==========================================================
1514*4882a593Smuzhiyun	  0  (default): do nothing
1515*4882a593Smuzhiyun	  1  Generate gratuitous arp requests when device is brought up
1516*4882a593Smuzhiyun	     or hardware address changes.
1517*4882a593Smuzhiyun	 ==  ==========================================================
1518*4882a593Smuzhiyun
1519*4882a593Smuzhiyunarp_accept - BOOLEAN
1520*4882a593Smuzhiyun	Define behavior for gratuitous ARP frames who's IP is not
1521*4882a593Smuzhiyun	already present in the ARP table:
1522*4882a593Smuzhiyun
1523*4882a593Smuzhiyun	- 0 - don't create new entries in the ARP table
1524*4882a593Smuzhiyun	- 1 - create new entries in the ARP table
1525*4882a593Smuzhiyun
1526*4882a593Smuzhiyun	Both replies and requests type gratuitous arp will trigger the
1527*4882a593Smuzhiyun	ARP table to be updated, if this setting is on.
1528*4882a593Smuzhiyun
1529*4882a593Smuzhiyun	If the ARP table already contains the IP address of the
1530*4882a593Smuzhiyun	gratuitous arp frame, the arp table will be updated regardless
1531*4882a593Smuzhiyun	if this setting is on or off.
1532*4882a593Smuzhiyun
1533*4882a593Smuzhiyunmcast_solicit - INTEGER
1534*4882a593Smuzhiyun	The maximum number of multicast probes in INCOMPLETE state,
1535*4882a593Smuzhiyun	when the associated hardware address is unknown.  Defaults
1536*4882a593Smuzhiyun	to 3.
1537*4882a593Smuzhiyun
1538*4882a593Smuzhiyunucast_solicit - INTEGER
1539*4882a593Smuzhiyun	The maximum number of unicast probes in PROBE state, when
1540*4882a593Smuzhiyun	the hardware address is being reconfirmed.  Defaults to 3.
1541*4882a593Smuzhiyun
1542*4882a593Smuzhiyunapp_solicit - INTEGER
1543*4882a593Smuzhiyun	The maximum number of probes to send to the user space ARP daemon
1544*4882a593Smuzhiyun	via netlink before dropping back to multicast probes (see
1545*4882a593Smuzhiyun	mcast_resolicit).  Defaults to 0.
1546*4882a593Smuzhiyun
1547*4882a593Smuzhiyunmcast_resolicit - INTEGER
1548*4882a593Smuzhiyun	The maximum number of multicast probes after unicast and
1549*4882a593Smuzhiyun	app probes in PROBE state.  Defaults to 0.
1550*4882a593Smuzhiyun
1551*4882a593Smuzhiyundisable_policy - BOOLEAN
1552*4882a593Smuzhiyun	Disable IPSEC policy (SPD) for this interface
1553*4882a593Smuzhiyun
1554*4882a593Smuzhiyundisable_xfrm - BOOLEAN
1555*4882a593Smuzhiyun	Disable IPSEC encryption on this interface, whatever the policy
1556*4882a593Smuzhiyun
1557*4882a593Smuzhiyunigmpv2_unsolicited_report_interval - INTEGER
1558*4882a593Smuzhiyun	The interval in milliseconds in which the next unsolicited
1559*4882a593Smuzhiyun	IGMPv1 or IGMPv2 report retransmit will take place.
1560*4882a593Smuzhiyun
1561*4882a593Smuzhiyun	Default: 10000 (10 seconds)
1562*4882a593Smuzhiyun
1563*4882a593Smuzhiyunigmpv3_unsolicited_report_interval - INTEGER
1564*4882a593Smuzhiyun	The interval in milliseconds in which the next unsolicited
1565*4882a593Smuzhiyun	IGMPv3 report retransmit will take place.
1566*4882a593Smuzhiyun
1567*4882a593Smuzhiyun	Default: 1000 (1 seconds)
1568*4882a593Smuzhiyun
1569*4882a593Smuzhiyunpromote_secondaries - BOOLEAN
1570*4882a593Smuzhiyun	When a primary IP address is removed from this interface
1571*4882a593Smuzhiyun	promote a corresponding secondary IP address instead of
1572*4882a593Smuzhiyun	removing all the corresponding secondary IP addresses.
1573*4882a593Smuzhiyun
1574*4882a593Smuzhiyundrop_unicast_in_l2_multicast - BOOLEAN
1575*4882a593Smuzhiyun	Drop any unicast IP packets that are received in link-layer
1576*4882a593Smuzhiyun	multicast (or broadcast) frames.
1577*4882a593Smuzhiyun
1578*4882a593Smuzhiyun	This behavior (for multicast) is actually a SHOULD in RFC
1579*4882a593Smuzhiyun	1122, but is disabled by default for compatibility reasons.
1580*4882a593Smuzhiyun
1581*4882a593Smuzhiyun	Default: off (0)
1582*4882a593Smuzhiyun
1583*4882a593Smuzhiyundrop_gratuitous_arp - BOOLEAN
1584*4882a593Smuzhiyun	Drop all gratuitous ARP frames, for example if there's a known
1585*4882a593Smuzhiyun	good ARP proxy on the network and such frames need not be used
1586*4882a593Smuzhiyun	(or in the case of 802.11, must not be used to prevent attacks.)
1587*4882a593Smuzhiyun
1588*4882a593Smuzhiyun	Default: off (0)
1589*4882a593Smuzhiyun
1590*4882a593Smuzhiyun
1591*4882a593Smuzhiyuntag - INTEGER
1592*4882a593Smuzhiyun	Allows you to write a number, which can be used as required.
1593*4882a593Smuzhiyun
1594*4882a593Smuzhiyun	Default value is 0.
1595*4882a593Smuzhiyun
1596*4882a593Smuzhiyunxfrm4_gc_thresh - INTEGER
1597*4882a593Smuzhiyun	(Obsolete since linux-4.14)
1598*4882a593Smuzhiyun	The threshold at which we will start garbage collecting for IPv4
1599*4882a593Smuzhiyun	destination cache entries.  At twice this value the system will
1600*4882a593Smuzhiyun	refuse new allocations.
1601*4882a593Smuzhiyun
1602*4882a593Smuzhiyunigmp_link_local_mcast_reports - BOOLEAN
1603*4882a593Smuzhiyun	Enable IGMP reports for link local multicast groups in the
1604*4882a593Smuzhiyun	224.0.0.X range.
1605*4882a593Smuzhiyun
1606*4882a593Smuzhiyun	Default TRUE
1607*4882a593Smuzhiyun
1608*4882a593SmuzhiyunAlexey Kuznetsov.
1609*4882a593Smuzhiyunkuznet@ms2.inr.ac.ru
1610*4882a593Smuzhiyun
1611*4882a593SmuzhiyunUpdated by:
1612*4882a593Smuzhiyun
1613*4882a593Smuzhiyun- Andi Kleen
1614*4882a593Smuzhiyun  ak@muc.de
1615*4882a593Smuzhiyun- Nicolas Delon
1616*4882a593Smuzhiyun  delon.nicolas@wanadoo.fr
1617*4882a593Smuzhiyun
1618*4882a593Smuzhiyun
1619*4882a593Smuzhiyun
1620*4882a593Smuzhiyun
1621*4882a593Smuzhiyun/proc/sys/net/ipv6/* Variables
1622*4882a593Smuzhiyun==============================
1623*4882a593Smuzhiyun
1624*4882a593SmuzhiyunIPv6 has no global variables such as tcp_*.  tcp_* settings under ipv4/ also
1625*4882a593Smuzhiyunapply to IPv6 [XXX?].
1626*4882a593Smuzhiyun
1627*4882a593Smuzhiyunbindv6only - BOOLEAN
1628*4882a593Smuzhiyun	Default value for IPV6_V6ONLY socket option,
1629*4882a593Smuzhiyun	which restricts use of the IPv6 socket to IPv6 communication
1630*4882a593Smuzhiyun	only.
1631*4882a593Smuzhiyun
1632*4882a593Smuzhiyun		- TRUE: disable IPv4-mapped address feature
1633*4882a593Smuzhiyun		- FALSE: enable IPv4-mapped address feature
1634*4882a593Smuzhiyun
1635*4882a593Smuzhiyun	Default: FALSE (as specified in RFC3493)
1636*4882a593Smuzhiyun
1637*4882a593Smuzhiyunflowlabel_consistency - BOOLEAN
1638*4882a593Smuzhiyun	Protect the consistency (and unicity) of flow label.
1639*4882a593Smuzhiyun	You have to disable it to use IPV6_FL_F_REFLECT flag on the
1640*4882a593Smuzhiyun	flow label manager.
1641*4882a593Smuzhiyun
1642*4882a593Smuzhiyun	- TRUE: enabled
1643*4882a593Smuzhiyun	- FALSE: disabled
1644*4882a593Smuzhiyun
1645*4882a593Smuzhiyun	Default: TRUE
1646*4882a593Smuzhiyun
1647*4882a593Smuzhiyunauto_flowlabels - INTEGER
1648*4882a593Smuzhiyun	Automatically generate flow labels based on a flow hash of the
1649*4882a593Smuzhiyun	packet. This allows intermediate devices, such as routers, to
1650*4882a593Smuzhiyun	identify packet flows for mechanisms like Equal Cost Multipath
1651*4882a593Smuzhiyun	Routing (see RFC 6438).
1652*4882a593Smuzhiyun
1653*4882a593Smuzhiyun	=  ===========================================================
1654*4882a593Smuzhiyun	0  automatic flow labels are completely disabled
1655*4882a593Smuzhiyun	1  automatic flow labels are enabled by default, they can be
1656*4882a593Smuzhiyun	   disabled on a per socket basis using the IPV6_AUTOFLOWLABEL
1657*4882a593Smuzhiyun	   socket option
1658*4882a593Smuzhiyun	2  automatic flow labels are allowed, they may be enabled on a
1659*4882a593Smuzhiyun	   per socket basis using the IPV6_AUTOFLOWLABEL socket option
1660*4882a593Smuzhiyun	3  automatic flow labels are enabled and enforced, they cannot
1661*4882a593Smuzhiyun	   be disabled by the socket option
1662*4882a593Smuzhiyun	=  ===========================================================
1663*4882a593Smuzhiyun
1664*4882a593Smuzhiyun	Default: 1
1665*4882a593Smuzhiyun
1666*4882a593Smuzhiyunflowlabel_state_ranges - BOOLEAN
1667*4882a593Smuzhiyun	Split the flow label number space into two ranges. 0-0x7FFFF is
1668*4882a593Smuzhiyun	reserved for the IPv6 flow manager facility, 0x80000-0xFFFFF
1669*4882a593Smuzhiyun	is reserved for stateless flow labels as described in RFC6437.
1670*4882a593Smuzhiyun
1671*4882a593Smuzhiyun	- TRUE: enabled
1672*4882a593Smuzhiyun	- FALSE: disabled
1673*4882a593Smuzhiyun
1674*4882a593Smuzhiyun	Default: true
1675*4882a593Smuzhiyun
1676*4882a593Smuzhiyunflowlabel_reflect - INTEGER
1677*4882a593Smuzhiyun	Control flow label reflection. Needed for Path MTU
1678*4882a593Smuzhiyun	Discovery to work with Equal Cost Multipath Routing in anycast
1679*4882a593Smuzhiyun	environments. See RFC 7690 and:
1680*4882a593Smuzhiyun	https://tools.ietf.org/html/draft-wang-6man-flow-label-reflection-01
1681*4882a593Smuzhiyun
1682*4882a593Smuzhiyun	This is a bitmask.
1683*4882a593Smuzhiyun
1684*4882a593Smuzhiyun	- 1: enabled for established flows
1685*4882a593Smuzhiyun
1686*4882a593Smuzhiyun	  Note that this prevents automatic flowlabel changes, as done
1687*4882a593Smuzhiyun	  in "tcp: change IPv6 flow-label upon receiving spurious retransmission"
1688*4882a593Smuzhiyun	  and "tcp: Change txhash on every SYN and RTO retransmit"
1689*4882a593Smuzhiyun
1690*4882a593Smuzhiyun	- 2: enabled for TCP RESET packets (no active listener)
1691*4882a593Smuzhiyun	  If set, a RST packet sent in response to a SYN packet on a closed
1692*4882a593Smuzhiyun	  port will reflect the incoming flow label.
1693*4882a593Smuzhiyun
1694*4882a593Smuzhiyun	- 4: enabled for ICMPv6 echo reply messages.
1695*4882a593Smuzhiyun
1696*4882a593Smuzhiyun	Default: 0
1697*4882a593Smuzhiyun
1698*4882a593Smuzhiyunfib_multipath_hash_policy - INTEGER
1699*4882a593Smuzhiyun	Controls which hash policy to use for multipath routes.
1700*4882a593Smuzhiyun
1701*4882a593Smuzhiyun	Default: 0 (Layer 3)
1702*4882a593Smuzhiyun
1703*4882a593Smuzhiyun	Possible values:
1704*4882a593Smuzhiyun
1705*4882a593Smuzhiyun	- 0 - Layer 3 (source and destination addresses plus flow label)
1706*4882a593Smuzhiyun	- 1 - Layer 4 (standard 5-tuple)
1707*4882a593Smuzhiyun	- 2 - Layer 3 or inner Layer 3 if present
1708*4882a593Smuzhiyun
1709*4882a593Smuzhiyunanycast_src_echo_reply - BOOLEAN
1710*4882a593Smuzhiyun	Controls the use of anycast addresses as source addresses for ICMPv6
1711*4882a593Smuzhiyun	echo reply
1712*4882a593Smuzhiyun
1713*4882a593Smuzhiyun	- TRUE:  enabled
1714*4882a593Smuzhiyun	- FALSE: disabled
1715*4882a593Smuzhiyun
1716*4882a593Smuzhiyun	Default: FALSE
1717*4882a593Smuzhiyun
1718*4882a593Smuzhiyunidgen_delay - INTEGER
1719*4882a593Smuzhiyun	Controls the delay in seconds after which time to retry
1720*4882a593Smuzhiyun	privacy stable address generation if a DAD conflict is
1721*4882a593Smuzhiyun	detected.
1722*4882a593Smuzhiyun
1723*4882a593Smuzhiyun	Default: 1 (as specified in RFC7217)
1724*4882a593Smuzhiyun
1725*4882a593Smuzhiyunidgen_retries - INTEGER
1726*4882a593Smuzhiyun	Controls the number of retries to generate a stable privacy
1727*4882a593Smuzhiyun	address if a DAD conflict is detected.
1728*4882a593Smuzhiyun
1729*4882a593Smuzhiyun	Default: 3 (as specified in RFC7217)
1730*4882a593Smuzhiyun
1731*4882a593Smuzhiyunmld_qrv - INTEGER
1732*4882a593Smuzhiyun	Controls the MLD query robustness variable (see RFC3810 9.1).
1733*4882a593Smuzhiyun
1734*4882a593Smuzhiyun	Default: 2 (as specified by RFC3810 9.1)
1735*4882a593Smuzhiyun
1736*4882a593Smuzhiyun	Minimum: 1 (as specified by RFC6636 4.5)
1737*4882a593Smuzhiyun
1738*4882a593Smuzhiyunmax_dst_opts_number - INTEGER
1739*4882a593Smuzhiyun	Maximum number of non-padding TLVs allowed in a Destination
1740*4882a593Smuzhiyun	options extension header. If this value is less than zero
1741*4882a593Smuzhiyun	then unknown options are disallowed and the number of known
1742*4882a593Smuzhiyun	TLVs allowed is the absolute value of this number.
1743*4882a593Smuzhiyun
1744*4882a593Smuzhiyun	Default: 8
1745*4882a593Smuzhiyun
1746*4882a593Smuzhiyunmax_hbh_opts_number - INTEGER
1747*4882a593Smuzhiyun	Maximum number of non-padding TLVs allowed in a Hop-by-Hop
1748*4882a593Smuzhiyun	options extension header. If this value is less than zero
1749*4882a593Smuzhiyun	then unknown options are disallowed and the number of known
1750*4882a593Smuzhiyun	TLVs allowed is the absolute value of this number.
1751*4882a593Smuzhiyun
1752*4882a593Smuzhiyun	Default: 8
1753*4882a593Smuzhiyun
1754*4882a593Smuzhiyunmax_dst_opts_length - INTEGER
1755*4882a593Smuzhiyun	Maximum length allowed for a Destination options extension
1756*4882a593Smuzhiyun	header.
1757*4882a593Smuzhiyun
1758*4882a593Smuzhiyun	Default: INT_MAX (unlimited)
1759*4882a593Smuzhiyun
1760*4882a593Smuzhiyunmax_hbh_length - INTEGER
1761*4882a593Smuzhiyun	Maximum length allowed for a Hop-by-Hop options extension
1762*4882a593Smuzhiyun	header.
1763*4882a593Smuzhiyun
1764*4882a593Smuzhiyun	Default: INT_MAX (unlimited)
1765*4882a593Smuzhiyun
1766*4882a593Smuzhiyunskip_notify_on_dev_down - BOOLEAN
1767*4882a593Smuzhiyun	Controls whether an RTM_DELROUTE message is generated for routes
1768*4882a593Smuzhiyun	removed when a device is taken down or deleted. IPv4 does not
1769*4882a593Smuzhiyun	generate this message; IPv6 does by default. Setting this sysctl
1770*4882a593Smuzhiyun	to true skips the message, making IPv4 and IPv6 on par in relying
1771*4882a593Smuzhiyun	on userspace caches to track link events and evict routes.
1772*4882a593Smuzhiyun
1773*4882a593Smuzhiyun	Default: false (generate message)
1774*4882a593Smuzhiyun
1775*4882a593Smuzhiyunnexthop_compat_mode - BOOLEAN
1776*4882a593Smuzhiyun	New nexthop API provides a means for managing nexthops independent of
1777*4882a593Smuzhiyun	prefixes. Backwards compatibilty with old route format is enabled by
1778*4882a593Smuzhiyun	default which means route dumps and notifications contain the new
1779*4882a593Smuzhiyun	nexthop attribute but also the full, expanded nexthop definition.
1780*4882a593Smuzhiyun	Further, updates or deletes of a nexthop configuration generate route
1781*4882a593Smuzhiyun	notifications for each fib entry using the nexthop. Once a system
1782*4882a593Smuzhiyun	understands the new API, this sysctl can be disabled to achieve full
1783*4882a593Smuzhiyun	performance benefits of the new API by disabling the nexthop expansion
1784*4882a593Smuzhiyun	and extraneous notifications.
1785*4882a593Smuzhiyun	Default: true (backward compat mode)
1786*4882a593Smuzhiyun
1787*4882a593SmuzhiyunIPv6 Fragmentation:
1788*4882a593Smuzhiyun
1789*4882a593Smuzhiyunip6frag_high_thresh - INTEGER
1790*4882a593Smuzhiyun	Maximum memory used to reassemble IPv6 fragments. When
1791*4882a593Smuzhiyun	ip6frag_high_thresh bytes of memory is allocated for this purpose,
1792*4882a593Smuzhiyun	the fragment handler will toss packets until ip6frag_low_thresh
1793*4882a593Smuzhiyun	is reached.
1794*4882a593Smuzhiyun
1795*4882a593Smuzhiyunip6frag_low_thresh - INTEGER
1796*4882a593Smuzhiyun	See ip6frag_high_thresh
1797*4882a593Smuzhiyun
1798*4882a593Smuzhiyunip6frag_time - INTEGER
1799*4882a593Smuzhiyun	Time in seconds to keep an IPv6 fragment in memory.
1800*4882a593Smuzhiyun
1801*4882a593SmuzhiyunIPv6 Segment Routing:
1802*4882a593Smuzhiyun
1803*4882a593Smuzhiyunseg6_flowlabel - INTEGER
1804*4882a593Smuzhiyun	Controls the behaviour of computing the flowlabel of outer
1805*4882a593Smuzhiyun	IPv6 header in case of SR T.encaps
1806*4882a593Smuzhiyun
1807*4882a593Smuzhiyun	 == =======================================================
1808*4882a593Smuzhiyun	 -1  set flowlabel to zero.
1809*4882a593Smuzhiyun	  0  copy flowlabel from Inner packet in case of Inner IPv6
1810*4882a593Smuzhiyun	     (Set flowlabel to 0 in case IPv4/L2)
1811*4882a593Smuzhiyun	  1  Compute the flowlabel using seg6_make_flowlabel()
1812*4882a593Smuzhiyun	 == =======================================================
1813*4882a593Smuzhiyun
1814*4882a593Smuzhiyun	Default is 0.
1815*4882a593Smuzhiyun
1816*4882a593Smuzhiyun``conf/default/*``:
1817*4882a593Smuzhiyun	Change the interface-specific default settings.
1818*4882a593Smuzhiyun
1819*4882a593Smuzhiyun
1820*4882a593Smuzhiyun``conf/all/*``:
1821*4882a593Smuzhiyun	Change all the interface-specific settings.
1822*4882a593Smuzhiyun
1823*4882a593Smuzhiyun	[XXX:  Other special features than forwarding?]
1824*4882a593Smuzhiyun
1825*4882a593Smuzhiyunconf/all/forwarding - BOOLEAN
1826*4882a593Smuzhiyun	Enable global IPv6 forwarding between all interfaces.
1827*4882a593Smuzhiyun
1828*4882a593Smuzhiyun	IPv4 and IPv6 work differently here; e.g. netfilter must be used
1829*4882a593Smuzhiyun	to control which interfaces may forward packets and which not.
1830*4882a593Smuzhiyun
1831*4882a593Smuzhiyun	This also sets all interfaces' Host/Router setting
1832*4882a593Smuzhiyun	'forwarding' to the specified value.  See below for details.
1833*4882a593Smuzhiyun
1834*4882a593Smuzhiyun	This referred to as global forwarding.
1835*4882a593Smuzhiyun
1836*4882a593Smuzhiyunproxy_ndp - BOOLEAN
1837*4882a593Smuzhiyun	Do proxy ndp.
1838*4882a593Smuzhiyun
1839*4882a593Smuzhiyunfwmark_reflect - BOOLEAN
1840*4882a593Smuzhiyun	Controls the fwmark of kernel-generated IPv6 reply packets that are not
1841*4882a593Smuzhiyun	associated with a socket for example, TCP RSTs or ICMPv6 echo replies).
1842*4882a593Smuzhiyun	If unset, these packets have a fwmark of zero. If set, they have the
1843*4882a593Smuzhiyun	fwmark of the packet they are replying to.
1844*4882a593Smuzhiyun
1845*4882a593Smuzhiyun	Default: 0
1846*4882a593Smuzhiyun
1847*4882a593Smuzhiyun``conf/interface/*``:
1848*4882a593Smuzhiyun	Change special settings per interface.
1849*4882a593Smuzhiyun
1850*4882a593Smuzhiyun	The functional behaviour for certain settings is different
1851*4882a593Smuzhiyun	depending on whether local forwarding is enabled or not.
1852*4882a593Smuzhiyun
1853*4882a593Smuzhiyunaccept_ra - INTEGER
1854*4882a593Smuzhiyun	Accept Router Advertisements; autoconfigure using them.
1855*4882a593Smuzhiyun
1856*4882a593Smuzhiyun	It also determines whether or not to transmit Router
1857*4882a593Smuzhiyun	Solicitations. If and only if the functional setting is to
1858*4882a593Smuzhiyun	accept Router Advertisements, Router Solicitations will be
1859*4882a593Smuzhiyun	transmitted.
1860*4882a593Smuzhiyun
1861*4882a593Smuzhiyun	Possible values are:
1862*4882a593Smuzhiyun
1863*4882a593Smuzhiyun		==  ===========================================================
1864*4882a593Smuzhiyun		 0  Do not accept Router Advertisements.
1865*4882a593Smuzhiyun		 1  Accept Router Advertisements if forwarding is disabled.
1866*4882a593Smuzhiyun		 2  Overrule forwarding behaviour. Accept Router Advertisements
1867*4882a593Smuzhiyun		    even if forwarding is enabled.
1868*4882a593Smuzhiyun		==  ===========================================================
1869*4882a593Smuzhiyun
1870*4882a593Smuzhiyun	Functional default:
1871*4882a593Smuzhiyun
1872*4882a593Smuzhiyun		- enabled if local forwarding is disabled.
1873*4882a593Smuzhiyun		- disabled if local forwarding is enabled.
1874*4882a593Smuzhiyun
1875*4882a593Smuzhiyunaccept_ra_defrtr - BOOLEAN
1876*4882a593Smuzhiyun	Learn default router in Router Advertisement.
1877*4882a593Smuzhiyun
1878*4882a593Smuzhiyun	Functional default:
1879*4882a593Smuzhiyun
1880*4882a593Smuzhiyun		- enabled if accept_ra is enabled.
1881*4882a593Smuzhiyun		- disabled if accept_ra is disabled.
1882*4882a593Smuzhiyun
1883*4882a593Smuzhiyunaccept_ra_from_local - BOOLEAN
1884*4882a593Smuzhiyun	Accept RA with source-address that is found on local machine
1885*4882a593Smuzhiyun	if the RA is otherwise proper and able to be accepted.
1886*4882a593Smuzhiyun
1887*4882a593Smuzhiyun	Default is to NOT accept these as it may be an un-intended
1888*4882a593Smuzhiyun	network loop.
1889*4882a593Smuzhiyun
1890*4882a593Smuzhiyun	Functional default:
1891*4882a593Smuzhiyun
1892*4882a593Smuzhiyun	   - enabled if accept_ra_from_local is enabled
1893*4882a593Smuzhiyun	     on a specific interface.
1894*4882a593Smuzhiyun	   - disabled if accept_ra_from_local is disabled
1895*4882a593Smuzhiyun	     on a specific interface.
1896*4882a593Smuzhiyun
1897*4882a593Smuzhiyunaccept_ra_min_hop_limit - INTEGER
1898*4882a593Smuzhiyun	Minimum hop limit Information in Router Advertisement.
1899*4882a593Smuzhiyun
1900*4882a593Smuzhiyun	Hop limit Information in Router Advertisement less than this
1901*4882a593Smuzhiyun	variable shall be ignored.
1902*4882a593Smuzhiyun
1903*4882a593Smuzhiyun	Default: 1
1904*4882a593Smuzhiyun
1905*4882a593Smuzhiyunaccept_ra_pinfo - BOOLEAN
1906*4882a593Smuzhiyun	Learn Prefix Information in Router Advertisement.
1907*4882a593Smuzhiyun
1908*4882a593Smuzhiyun	Functional default:
1909*4882a593Smuzhiyun
1910*4882a593Smuzhiyun		- enabled if accept_ra is enabled.
1911*4882a593Smuzhiyun		- disabled if accept_ra is disabled.
1912*4882a593Smuzhiyun
1913*4882a593Smuzhiyunaccept_ra_rt_info_min_plen - INTEGER
1914*4882a593Smuzhiyun	Minimum prefix length of Route Information in RA.
1915*4882a593Smuzhiyun
1916*4882a593Smuzhiyun	Route Information w/ prefix smaller than this variable shall
1917*4882a593Smuzhiyun	be ignored.
1918*4882a593Smuzhiyun
1919*4882a593Smuzhiyun	Functional default:
1920*4882a593Smuzhiyun
1921*4882a593Smuzhiyun		* 0 if accept_ra_rtr_pref is enabled.
1922*4882a593Smuzhiyun		* -1 if accept_ra_rtr_pref is disabled.
1923*4882a593Smuzhiyun
1924*4882a593Smuzhiyunaccept_ra_rt_info_max_plen - INTEGER
1925*4882a593Smuzhiyun	Maximum prefix length of Route Information in RA.
1926*4882a593Smuzhiyun
1927*4882a593Smuzhiyun	Route Information w/ prefix larger than this variable shall
1928*4882a593Smuzhiyun	be ignored.
1929*4882a593Smuzhiyun
1930*4882a593Smuzhiyun	Functional default:
1931*4882a593Smuzhiyun
1932*4882a593Smuzhiyun		* 0 if accept_ra_rtr_pref is enabled.
1933*4882a593Smuzhiyun		* -1 if accept_ra_rtr_pref is disabled.
1934*4882a593Smuzhiyun
1935*4882a593Smuzhiyunaccept_ra_rtr_pref - BOOLEAN
1936*4882a593Smuzhiyun	Accept Router Preference in RA.
1937*4882a593Smuzhiyun
1938*4882a593Smuzhiyun	Functional default:
1939*4882a593Smuzhiyun
1940*4882a593Smuzhiyun		- enabled if accept_ra is enabled.
1941*4882a593Smuzhiyun		- disabled if accept_ra is disabled.
1942*4882a593Smuzhiyun
1943*4882a593Smuzhiyunaccept_ra_mtu - BOOLEAN
1944*4882a593Smuzhiyun	Apply the MTU value specified in RA option 5 (RFC4861). If
1945*4882a593Smuzhiyun	disabled, the MTU specified in the RA will be ignored.
1946*4882a593Smuzhiyun
1947*4882a593Smuzhiyun	Functional default:
1948*4882a593Smuzhiyun
1949*4882a593Smuzhiyun		- enabled if accept_ra is enabled.
1950*4882a593Smuzhiyun		- disabled if accept_ra is disabled.
1951*4882a593Smuzhiyun
1952*4882a593Smuzhiyunaccept_redirects - BOOLEAN
1953*4882a593Smuzhiyun	Accept Redirects.
1954*4882a593Smuzhiyun
1955*4882a593Smuzhiyun	Functional default:
1956*4882a593Smuzhiyun
1957*4882a593Smuzhiyun		- enabled if local forwarding is disabled.
1958*4882a593Smuzhiyun		- disabled if local forwarding is enabled.
1959*4882a593Smuzhiyun
1960*4882a593Smuzhiyunaccept_source_route - INTEGER
1961*4882a593Smuzhiyun	Accept source routing (routing extension header).
1962*4882a593Smuzhiyun
1963*4882a593Smuzhiyun	- >= 0: Accept only routing header type 2.
1964*4882a593Smuzhiyun	- < 0: Do not accept routing header.
1965*4882a593Smuzhiyun
1966*4882a593Smuzhiyun	Default: 0
1967*4882a593Smuzhiyun
1968*4882a593Smuzhiyunautoconf - BOOLEAN
1969*4882a593Smuzhiyun	Autoconfigure addresses using Prefix Information in Router
1970*4882a593Smuzhiyun	Advertisements.
1971*4882a593Smuzhiyun
1972*4882a593Smuzhiyun	Functional default:
1973*4882a593Smuzhiyun
1974*4882a593Smuzhiyun		- enabled if accept_ra_pinfo is enabled.
1975*4882a593Smuzhiyun		- disabled if accept_ra_pinfo is disabled.
1976*4882a593Smuzhiyun
1977*4882a593Smuzhiyundad_transmits - INTEGER
1978*4882a593Smuzhiyun	The amount of Duplicate Address Detection probes to send.
1979*4882a593Smuzhiyun
1980*4882a593Smuzhiyun	Default: 1
1981*4882a593Smuzhiyun
1982*4882a593Smuzhiyunforwarding - INTEGER
1983*4882a593Smuzhiyun	Configure interface-specific Host/Router behaviour.
1984*4882a593Smuzhiyun
1985*4882a593Smuzhiyun	.. note::
1986*4882a593Smuzhiyun
1987*4882a593Smuzhiyun	   It is recommended to have the same setting on all
1988*4882a593Smuzhiyun	   interfaces; mixed router/host scenarios are rather uncommon.
1989*4882a593Smuzhiyun
1990*4882a593Smuzhiyun	Possible values are:
1991*4882a593Smuzhiyun
1992*4882a593Smuzhiyun		- 0 Forwarding disabled
1993*4882a593Smuzhiyun		- 1 Forwarding enabled
1994*4882a593Smuzhiyun
1995*4882a593Smuzhiyun	**FALSE (0)**:
1996*4882a593Smuzhiyun
1997*4882a593Smuzhiyun	By default, Host behaviour is assumed.  This means:
1998*4882a593Smuzhiyun
1999*4882a593Smuzhiyun	1. IsRouter flag is not set in Neighbour Advertisements.
2000*4882a593Smuzhiyun	2. If accept_ra is TRUE (default), transmit Router
2001*4882a593Smuzhiyun	   Solicitations.
2002*4882a593Smuzhiyun	3. If accept_ra is TRUE (default), accept Router
2003*4882a593Smuzhiyun	   Advertisements (and do autoconfiguration).
2004*4882a593Smuzhiyun	4. If accept_redirects is TRUE (default), accept Redirects.
2005*4882a593Smuzhiyun
2006*4882a593Smuzhiyun	**TRUE (1)**:
2007*4882a593Smuzhiyun
2008*4882a593Smuzhiyun	If local forwarding is enabled, Router behaviour is assumed.
2009*4882a593Smuzhiyun	This means exactly the reverse from the above:
2010*4882a593Smuzhiyun
2011*4882a593Smuzhiyun	1. IsRouter flag is set in Neighbour Advertisements.
2012*4882a593Smuzhiyun	2. Router Solicitations are not sent unless accept_ra is 2.
2013*4882a593Smuzhiyun	3. Router Advertisements are ignored unless accept_ra is 2.
2014*4882a593Smuzhiyun	4. Redirects are ignored.
2015*4882a593Smuzhiyun
2016*4882a593Smuzhiyun	Default: 0 (disabled) if global forwarding is disabled (default),
2017*4882a593Smuzhiyun	otherwise 1 (enabled).
2018*4882a593Smuzhiyun
2019*4882a593Smuzhiyunhop_limit - INTEGER
2020*4882a593Smuzhiyun	Default Hop Limit to set.
2021*4882a593Smuzhiyun
2022*4882a593Smuzhiyun	Default: 64
2023*4882a593Smuzhiyun
2024*4882a593Smuzhiyunmtu - INTEGER
2025*4882a593Smuzhiyun	Default Maximum Transfer Unit
2026*4882a593Smuzhiyun
2027*4882a593Smuzhiyun	Default: 1280 (IPv6 required minimum)
2028*4882a593Smuzhiyun
2029*4882a593Smuzhiyunip_nonlocal_bind - BOOLEAN
2030*4882a593Smuzhiyun	If set, allows processes to bind() to non-local IPv6 addresses,
2031*4882a593Smuzhiyun	which can be quite useful - but may break some applications.
2032*4882a593Smuzhiyun
2033*4882a593Smuzhiyun	Default: 0
2034*4882a593Smuzhiyun
2035*4882a593Smuzhiyunrouter_probe_interval - INTEGER
2036*4882a593Smuzhiyun	Minimum interval (in seconds) between Router Probing described
2037*4882a593Smuzhiyun	in RFC4191.
2038*4882a593Smuzhiyun
2039*4882a593Smuzhiyun	Default: 60
2040*4882a593Smuzhiyun
2041*4882a593Smuzhiyunrouter_solicitation_delay - INTEGER
2042*4882a593Smuzhiyun	Number of seconds to wait after interface is brought up
2043*4882a593Smuzhiyun	before sending Router Solicitations.
2044*4882a593Smuzhiyun
2045*4882a593Smuzhiyun	Default: 1
2046*4882a593Smuzhiyun
2047*4882a593Smuzhiyunrouter_solicitation_interval - INTEGER
2048*4882a593Smuzhiyun	Number of seconds to wait between Router Solicitations.
2049*4882a593Smuzhiyun
2050*4882a593Smuzhiyun	Default: 4
2051*4882a593Smuzhiyun
2052*4882a593Smuzhiyunrouter_solicitations - INTEGER
2053*4882a593Smuzhiyun	Number of Router Solicitations to send until assuming no
2054*4882a593Smuzhiyun	routers are present.
2055*4882a593Smuzhiyun
2056*4882a593Smuzhiyun	Default: 3
2057*4882a593Smuzhiyun
2058*4882a593Smuzhiyunuse_oif_addrs_only - BOOLEAN
2059*4882a593Smuzhiyun	When enabled, the candidate source addresses for destinations
2060*4882a593Smuzhiyun	routed via this interface are restricted to the set of addresses
2061*4882a593Smuzhiyun	configured on this interface (vis. RFC 6724, section 4).
2062*4882a593Smuzhiyun
2063*4882a593Smuzhiyun	Default: false
2064*4882a593Smuzhiyun
2065*4882a593Smuzhiyunuse_tempaddr - INTEGER
2066*4882a593Smuzhiyun	Preference for Privacy Extensions (RFC3041).
2067*4882a593Smuzhiyun
2068*4882a593Smuzhiyun	  * <= 0 : disable Privacy Extensions
2069*4882a593Smuzhiyun	  * == 1 : enable Privacy Extensions, but prefer public
2070*4882a593Smuzhiyun	    addresses over temporary addresses.
2071*4882a593Smuzhiyun	  * >  1 : enable Privacy Extensions and prefer temporary
2072*4882a593Smuzhiyun	    addresses over public addresses.
2073*4882a593Smuzhiyun
2074*4882a593Smuzhiyun	Default:
2075*4882a593Smuzhiyun
2076*4882a593Smuzhiyun		* 0 (for most devices)
2077*4882a593Smuzhiyun		* -1 (for point-to-point devices and loopback devices)
2078*4882a593Smuzhiyun
2079*4882a593Smuzhiyuntemp_valid_lft - INTEGER
2080*4882a593Smuzhiyun	valid lifetime (in seconds) for temporary addresses.
2081*4882a593Smuzhiyun
2082*4882a593Smuzhiyun	Default: 172800 (2 days)
2083*4882a593Smuzhiyun
2084*4882a593Smuzhiyuntemp_prefered_lft - INTEGER
2085*4882a593Smuzhiyun	Preferred lifetime (in seconds) for temporary addresses.
2086*4882a593Smuzhiyun
2087*4882a593Smuzhiyun	Default: 86400 (1 day)
2088*4882a593Smuzhiyun
2089*4882a593Smuzhiyunkeep_addr_on_down - INTEGER
2090*4882a593Smuzhiyun	Keep all IPv6 addresses on an interface down event. If set static
2091*4882a593Smuzhiyun	global addresses with no expiration time are not flushed.
2092*4882a593Smuzhiyun
2093*4882a593Smuzhiyun	*   >0 : enabled
2094*4882a593Smuzhiyun	*    0 : system default
2095*4882a593Smuzhiyun	*   <0 : disabled
2096*4882a593Smuzhiyun
2097*4882a593Smuzhiyun	Default: 0 (addresses are removed)
2098*4882a593Smuzhiyun
2099*4882a593Smuzhiyunmax_desync_factor - INTEGER
2100*4882a593Smuzhiyun	Maximum value for DESYNC_FACTOR, which is a random value
2101*4882a593Smuzhiyun	that ensures that clients don't synchronize with each
2102*4882a593Smuzhiyun	other and generate new addresses at exactly the same time.
2103*4882a593Smuzhiyun	value is in seconds.
2104*4882a593Smuzhiyun
2105*4882a593Smuzhiyun	Default: 600
2106*4882a593Smuzhiyun
2107*4882a593Smuzhiyunregen_max_retry - INTEGER
2108*4882a593Smuzhiyun	Number of attempts before give up attempting to generate
2109*4882a593Smuzhiyun	valid temporary addresses.
2110*4882a593Smuzhiyun
2111*4882a593Smuzhiyun	Default: 5
2112*4882a593Smuzhiyun
2113*4882a593Smuzhiyunmax_addresses - INTEGER
2114*4882a593Smuzhiyun	Maximum number of autoconfigured addresses per interface.  Setting
2115*4882a593Smuzhiyun	to zero disables the limitation.  It is not recommended to set this
2116*4882a593Smuzhiyun	value too large (or to zero) because it would be an easy way to
2117*4882a593Smuzhiyun	crash the kernel by allowing too many addresses to be created.
2118*4882a593Smuzhiyun
2119*4882a593Smuzhiyun	Default: 16
2120*4882a593Smuzhiyun
2121*4882a593Smuzhiyundisable_ipv6 - BOOLEAN
2122*4882a593Smuzhiyun	Disable IPv6 operation.  If accept_dad is set to 2, this value
2123*4882a593Smuzhiyun	will be dynamically set to TRUE if DAD fails for the link-local
2124*4882a593Smuzhiyun	address.
2125*4882a593Smuzhiyun
2126*4882a593Smuzhiyun	Default: FALSE (enable IPv6 operation)
2127*4882a593Smuzhiyun
2128*4882a593Smuzhiyun	When this value is changed from 1 to 0 (IPv6 is being enabled),
2129*4882a593Smuzhiyun	it will dynamically create a link-local address on the given
2130*4882a593Smuzhiyun	interface and start Duplicate Address Detection, if necessary.
2131*4882a593Smuzhiyun
2132*4882a593Smuzhiyun	When this value is changed from 0 to 1 (IPv6 is being disabled),
2133*4882a593Smuzhiyun	it will dynamically delete all addresses and routes on the given
2134*4882a593Smuzhiyun	interface. From now on it will not possible to add addresses/routes
2135*4882a593Smuzhiyun	to the selected interface.
2136*4882a593Smuzhiyun
2137*4882a593Smuzhiyunaccept_dad - INTEGER
2138*4882a593Smuzhiyun	Whether to accept DAD (Duplicate Address Detection).
2139*4882a593Smuzhiyun
2140*4882a593Smuzhiyun	 == ==============================================================
2141*4882a593Smuzhiyun	  0  Disable DAD
2142*4882a593Smuzhiyun	  1  Enable DAD (default)
2143*4882a593Smuzhiyun	  2  Enable DAD, and disable IPv6 operation if MAC-based duplicate
2144*4882a593Smuzhiyun	     link-local address has been found.
2145*4882a593Smuzhiyun	 == ==============================================================
2146*4882a593Smuzhiyun
2147*4882a593Smuzhiyun	DAD operation and mode on a given interface will be selected according
2148*4882a593Smuzhiyun	to the maximum value of conf/{all,interface}/accept_dad.
2149*4882a593Smuzhiyun
2150*4882a593Smuzhiyunforce_tllao - BOOLEAN
2151*4882a593Smuzhiyun	Enable sending the target link-layer address option even when
2152*4882a593Smuzhiyun	responding to a unicast neighbor solicitation.
2153*4882a593Smuzhiyun
2154*4882a593Smuzhiyun	Default: FALSE
2155*4882a593Smuzhiyun
2156*4882a593Smuzhiyun	Quoting from RFC 2461, section 4.4, Target link-layer address:
2157*4882a593Smuzhiyun
2158*4882a593Smuzhiyun	"The option MUST be included for multicast solicitations in order to
2159*4882a593Smuzhiyun	avoid infinite Neighbor Solicitation "recursion" when the peer node
2160*4882a593Smuzhiyun	does not have a cache entry to return a Neighbor Advertisements
2161*4882a593Smuzhiyun	message.  When responding to unicast solicitations, the option can be
2162*4882a593Smuzhiyun	omitted since the sender of the solicitation has the correct link-
2163*4882a593Smuzhiyun	layer address; otherwise it would not have be able to send the unicast
2164*4882a593Smuzhiyun	solicitation in the first place. However, including the link-layer
2165*4882a593Smuzhiyun	address in this case adds little overhead and eliminates a potential
2166*4882a593Smuzhiyun	race condition where the sender deletes the cached link-layer address
2167*4882a593Smuzhiyun	prior to receiving a response to a previous solicitation."
2168*4882a593Smuzhiyun
2169*4882a593Smuzhiyunndisc_notify - BOOLEAN
2170*4882a593Smuzhiyun	Define mode for notification of address and device changes.
2171*4882a593Smuzhiyun
2172*4882a593Smuzhiyun	* 0 - (default): do nothing
2173*4882a593Smuzhiyun	* 1 - Generate unsolicited neighbour advertisements when device is brought
2174*4882a593Smuzhiyun	  up or hardware address changes.
2175*4882a593Smuzhiyun
2176*4882a593Smuzhiyunndisc_tclass - INTEGER
2177*4882a593Smuzhiyun	The IPv6 Traffic Class to use by default when sending IPv6 Neighbor
2178*4882a593Smuzhiyun	Discovery (Router Solicitation, Router Advertisement, Neighbor
2179*4882a593Smuzhiyun	Solicitation, Neighbor Advertisement, Redirect) messages.
2180*4882a593Smuzhiyun	These 8 bits can be interpreted as 6 high order bits holding the DSCP
2181*4882a593Smuzhiyun	value and 2 low order bits representing ECN (which you probably want
2182*4882a593Smuzhiyun	to leave cleared).
2183*4882a593Smuzhiyun
2184*4882a593Smuzhiyun	* 0 - (default)
2185*4882a593Smuzhiyun
2186*4882a593Smuzhiyunmldv1_unsolicited_report_interval - INTEGER
2187*4882a593Smuzhiyun	The interval in milliseconds in which the next unsolicited
2188*4882a593Smuzhiyun	MLDv1 report retransmit will take place.
2189*4882a593Smuzhiyun
2190*4882a593Smuzhiyun	Default: 10000 (10 seconds)
2191*4882a593Smuzhiyun
2192*4882a593Smuzhiyunmldv2_unsolicited_report_interval - INTEGER
2193*4882a593Smuzhiyun	The interval in milliseconds in which the next unsolicited
2194*4882a593Smuzhiyun	MLDv2 report retransmit will take place.
2195*4882a593Smuzhiyun
2196*4882a593Smuzhiyun	Default: 1000 (1 second)
2197*4882a593Smuzhiyun
2198*4882a593Smuzhiyunforce_mld_version - INTEGER
2199*4882a593Smuzhiyun	* 0 - (default) No enforcement of a MLD version, MLDv1 fallback allowed
2200*4882a593Smuzhiyun	* 1 - Enforce to use MLD version 1
2201*4882a593Smuzhiyun	* 2 - Enforce to use MLD version 2
2202*4882a593Smuzhiyun
2203*4882a593Smuzhiyunsuppress_frag_ndisc - INTEGER
2204*4882a593Smuzhiyun	Control RFC 6980 (Security Implications of IPv6 Fragmentation
2205*4882a593Smuzhiyun	with IPv6 Neighbor Discovery) behavior:
2206*4882a593Smuzhiyun
2207*4882a593Smuzhiyun	* 1 - (default) discard fragmented neighbor discovery packets
2208*4882a593Smuzhiyun	* 0 - allow fragmented neighbor discovery packets
2209*4882a593Smuzhiyun
2210*4882a593Smuzhiyunoptimistic_dad - BOOLEAN
2211*4882a593Smuzhiyun	Whether to perform Optimistic Duplicate Address Detection (RFC 4429).
2212*4882a593Smuzhiyun
2213*4882a593Smuzhiyun	* 0: disabled (default)
2214*4882a593Smuzhiyun	* 1: enabled
2215*4882a593Smuzhiyun
2216*4882a593Smuzhiyun	Optimistic Duplicate Address Detection for the interface will be enabled
2217*4882a593Smuzhiyun	if at least one of conf/{all,interface}/optimistic_dad is set to 1,
2218*4882a593Smuzhiyun	it will be disabled otherwise.
2219*4882a593Smuzhiyun
2220*4882a593Smuzhiyunuse_optimistic - BOOLEAN
2221*4882a593Smuzhiyun	If enabled, do not classify optimistic addresses as deprecated during
2222*4882a593Smuzhiyun	source address selection.  Preferred addresses will still be chosen
2223*4882a593Smuzhiyun	before optimistic addresses, subject to other ranking in the source
2224*4882a593Smuzhiyun	address selection algorithm.
2225*4882a593Smuzhiyun
2226*4882a593Smuzhiyun	* 0: disabled (default)
2227*4882a593Smuzhiyun	* 1: enabled
2228*4882a593Smuzhiyun
2229*4882a593Smuzhiyun	This will be enabled if at least one of
2230*4882a593Smuzhiyun	conf/{all,interface}/use_optimistic is set to 1, disabled otherwise.
2231*4882a593Smuzhiyun
2232*4882a593Smuzhiyunstable_secret - IPv6 address
2233*4882a593Smuzhiyun	This IPv6 address will be used as a secret to generate IPv6
2234*4882a593Smuzhiyun	addresses for link-local addresses and autoconfigured
2235*4882a593Smuzhiyun	ones. All addresses generated after setting this secret will
2236*4882a593Smuzhiyun	be stable privacy ones by default. This can be changed via the
2237*4882a593Smuzhiyun	addrgenmode ip-link. conf/default/stable_secret is used as the
2238*4882a593Smuzhiyun	secret for the namespace, the interface specific ones can
2239*4882a593Smuzhiyun	overwrite that. Writes to conf/all/stable_secret are refused.
2240*4882a593Smuzhiyun
2241*4882a593Smuzhiyun	It is recommended to generate this secret during installation
2242*4882a593Smuzhiyun	of a system and keep it stable after that.
2243*4882a593Smuzhiyun
2244*4882a593Smuzhiyun	By default the stable secret is unset.
2245*4882a593Smuzhiyun
2246*4882a593Smuzhiyunaddr_gen_mode - INTEGER
2247*4882a593Smuzhiyun	Defines how link-local and autoconf addresses are generated.
2248*4882a593Smuzhiyun
2249*4882a593Smuzhiyun	=  =================================================================
2250*4882a593Smuzhiyun	0  generate address based on EUI64 (default)
2251*4882a593Smuzhiyun	1  do no generate a link-local address, use EUI64 for addresses
2252*4882a593Smuzhiyun	   generated from autoconf
2253*4882a593Smuzhiyun	2  generate stable privacy addresses, using the secret from
2254*4882a593Smuzhiyun	   stable_secret (RFC7217)
2255*4882a593Smuzhiyun	3  generate stable privacy addresses, using a random secret if unset
2256*4882a593Smuzhiyun	=  =================================================================
2257*4882a593Smuzhiyun
2258*4882a593Smuzhiyundrop_unicast_in_l2_multicast - BOOLEAN
2259*4882a593Smuzhiyun	Drop any unicast IPv6 packets that are received in link-layer
2260*4882a593Smuzhiyun	multicast (or broadcast) frames.
2261*4882a593Smuzhiyun
2262*4882a593Smuzhiyun	By default this is turned off.
2263*4882a593Smuzhiyun
2264*4882a593Smuzhiyundrop_unsolicited_na - BOOLEAN
2265*4882a593Smuzhiyun	Drop all unsolicited neighbor advertisements, for example if there's
2266*4882a593Smuzhiyun	a known good NA proxy on the network and such frames need not be used
2267*4882a593Smuzhiyun	(or in the case of 802.11, must not be used to prevent attacks.)
2268*4882a593Smuzhiyun
2269*4882a593Smuzhiyun	By default this is turned off.
2270*4882a593Smuzhiyun
2271*4882a593Smuzhiyunenhanced_dad - BOOLEAN
2272*4882a593Smuzhiyun	Include a nonce option in the IPv6 neighbor solicitation messages used for
2273*4882a593Smuzhiyun	duplicate address detection per RFC7527. A received DAD NS will only signal
2274*4882a593Smuzhiyun	a duplicate address if the nonce is different. This avoids any false
2275*4882a593Smuzhiyun	detection of duplicates due to loopback of the NS messages that we send.
2276*4882a593Smuzhiyun	The nonce option will be sent on an interface unless both of
2277*4882a593Smuzhiyun	conf/{all,interface}/enhanced_dad are set to FALSE.
2278*4882a593Smuzhiyun
2279*4882a593Smuzhiyun	Default: TRUE
2280*4882a593Smuzhiyun
2281*4882a593Smuzhiyun``icmp/*``:
2282*4882a593Smuzhiyun===========
2283*4882a593Smuzhiyun
2284*4882a593Smuzhiyunratelimit - INTEGER
2285*4882a593Smuzhiyun	Limit the maximal rates for sending ICMPv6 messages.
2286*4882a593Smuzhiyun
2287*4882a593Smuzhiyun	0 to disable any limiting,
2288*4882a593Smuzhiyun	otherwise the minimal space between responses in milliseconds.
2289*4882a593Smuzhiyun
2290*4882a593Smuzhiyun	Default: 1000
2291*4882a593Smuzhiyun
2292*4882a593Smuzhiyunratemask - list of comma separated ranges
2293*4882a593Smuzhiyun	For ICMPv6 message types matching the ranges in the ratemask, limit
2294*4882a593Smuzhiyun	the sending of the message according to ratelimit parameter.
2295*4882a593Smuzhiyun
2296*4882a593Smuzhiyun	The format used for both input and output is a comma separated
2297*4882a593Smuzhiyun	list of ranges (e.g. "0-127,129" for ICMPv6 message type 0 to 127 and
2298*4882a593Smuzhiyun	129). Writing to the file will clear all previous ranges of ICMPv6
2299*4882a593Smuzhiyun	message types and update the current list with the input.
2300*4882a593Smuzhiyun
2301*4882a593Smuzhiyun	Refer to: https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml
2302*4882a593Smuzhiyun	for numerical values of ICMPv6 message types, e.g. echo request is 128
2303*4882a593Smuzhiyun	and echo reply is 129.
2304*4882a593Smuzhiyun
2305*4882a593Smuzhiyun	Default: 0-1,3-127 (rate limit ICMPv6 errors except Packet Too Big)
2306*4882a593Smuzhiyun
2307*4882a593Smuzhiyunecho_ignore_all - BOOLEAN
2308*4882a593Smuzhiyun	If set non-zero, then the kernel will ignore all ICMP ECHO
2309*4882a593Smuzhiyun	requests sent to it over the IPv6 protocol.
2310*4882a593Smuzhiyun
2311*4882a593Smuzhiyun	Default: 0
2312*4882a593Smuzhiyun
2313*4882a593Smuzhiyunecho_ignore_multicast - BOOLEAN
2314*4882a593Smuzhiyun	If set non-zero, then the kernel will ignore all ICMP ECHO
2315*4882a593Smuzhiyun	requests sent to it over the IPv6 protocol via multicast.
2316*4882a593Smuzhiyun
2317*4882a593Smuzhiyun	Default: 0
2318*4882a593Smuzhiyun
2319*4882a593Smuzhiyunecho_ignore_anycast - BOOLEAN
2320*4882a593Smuzhiyun	If set non-zero, then the kernel will ignore all ICMP ECHO
2321*4882a593Smuzhiyun	requests sent to it over the IPv6 protocol destined to anycast address.
2322*4882a593Smuzhiyun
2323*4882a593Smuzhiyun	Default: 0
2324*4882a593Smuzhiyun
2325*4882a593Smuzhiyunxfrm6_gc_thresh - INTEGER
2326*4882a593Smuzhiyun	(Obsolete since linux-4.14)
2327*4882a593Smuzhiyun	The threshold at which we will start garbage collecting for IPv6
2328*4882a593Smuzhiyun	destination cache entries.  At twice this value the system will
2329*4882a593Smuzhiyun	refuse new allocations.
2330*4882a593Smuzhiyun
2331*4882a593Smuzhiyun
2332*4882a593SmuzhiyunIPv6 Update by:
2333*4882a593SmuzhiyunPekka Savola <pekkas@netcore.fi>
2334*4882a593SmuzhiyunYOSHIFUJI Hideaki / USAGI Project <yoshfuji@linux-ipv6.org>
2335*4882a593Smuzhiyun
2336*4882a593Smuzhiyun
2337*4882a593Smuzhiyun/proc/sys/net/bridge/* Variables:
2338*4882a593Smuzhiyun=================================
2339*4882a593Smuzhiyun
2340*4882a593Smuzhiyunbridge-nf-call-arptables - BOOLEAN
2341*4882a593Smuzhiyun	- 1 : pass bridged ARP traffic to arptables' FORWARD chain.
2342*4882a593Smuzhiyun	- 0 : disable this.
2343*4882a593Smuzhiyun
2344*4882a593Smuzhiyun	Default: 1
2345*4882a593Smuzhiyun
2346*4882a593Smuzhiyunbridge-nf-call-iptables - BOOLEAN
2347*4882a593Smuzhiyun	- 1 : pass bridged IPv4 traffic to iptables' chains.
2348*4882a593Smuzhiyun	- 0 : disable this.
2349*4882a593Smuzhiyun
2350*4882a593Smuzhiyun	Default: 1
2351*4882a593Smuzhiyun
2352*4882a593Smuzhiyunbridge-nf-call-ip6tables - BOOLEAN
2353*4882a593Smuzhiyun	- 1 : pass bridged IPv6 traffic to ip6tables' chains.
2354*4882a593Smuzhiyun	- 0 : disable this.
2355*4882a593Smuzhiyun
2356*4882a593Smuzhiyun	Default: 1
2357*4882a593Smuzhiyun
2358*4882a593Smuzhiyunbridge-nf-filter-vlan-tagged - BOOLEAN
2359*4882a593Smuzhiyun	- 1 : pass bridged vlan-tagged ARP/IP/IPv6 traffic to {arp,ip,ip6}tables.
2360*4882a593Smuzhiyun	- 0 : disable this.
2361*4882a593Smuzhiyun
2362*4882a593Smuzhiyun	Default: 0
2363*4882a593Smuzhiyun
2364*4882a593Smuzhiyunbridge-nf-filter-pppoe-tagged - BOOLEAN
2365*4882a593Smuzhiyun	- 1 : pass bridged pppoe-tagged IP/IPv6 traffic to {ip,ip6}tables.
2366*4882a593Smuzhiyun	- 0 : disable this.
2367*4882a593Smuzhiyun
2368*4882a593Smuzhiyun	Default: 0
2369*4882a593Smuzhiyun
2370*4882a593Smuzhiyunbridge-nf-pass-vlan-input-dev - BOOLEAN
2371*4882a593Smuzhiyun	- 1: if bridge-nf-filter-vlan-tagged is enabled, try to find a vlan
2372*4882a593Smuzhiyun	  interface on the bridge and set the netfilter input device to the
2373*4882a593Smuzhiyun	  vlan. This allows use of e.g. "iptables -i br0.1" and makes the
2374*4882a593Smuzhiyun	  REDIRECT target work with vlan-on-top-of-bridge interfaces.  When no
2375*4882a593Smuzhiyun	  matching vlan interface is found, or this switch is off, the input
2376*4882a593Smuzhiyun	  device is set to the bridge interface.
2377*4882a593Smuzhiyun
2378*4882a593Smuzhiyun	- 0: disable bridge netfilter vlan interface lookup.
2379*4882a593Smuzhiyun
2380*4882a593Smuzhiyun	Default: 0
2381*4882a593Smuzhiyun
2382*4882a593Smuzhiyun``proc/sys/net/sctp/*`` Variables:
2383*4882a593Smuzhiyun==================================
2384*4882a593Smuzhiyun
2385*4882a593Smuzhiyunaddip_enable - BOOLEAN
2386*4882a593Smuzhiyun	Enable or disable extension of  Dynamic Address Reconfiguration
2387*4882a593Smuzhiyun	(ADD-IP) functionality specified in RFC5061.  This extension provides
2388*4882a593Smuzhiyun	the ability to dynamically add and remove new addresses for the SCTP
2389*4882a593Smuzhiyun	associations.
2390*4882a593Smuzhiyun
2391*4882a593Smuzhiyun	1: Enable extension.
2392*4882a593Smuzhiyun
2393*4882a593Smuzhiyun	0: Disable extension.
2394*4882a593Smuzhiyun
2395*4882a593Smuzhiyun	Default: 0
2396*4882a593Smuzhiyun
2397*4882a593Smuzhiyunpf_enable - INTEGER
2398*4882a593Smuzhiyun	Enable or disable pf (pf is short for potentially failed) state. A value
2399*4882a593Smuzhiyun	of pf_retrans > path_max_retrans also disables pf state. That is, one of
2400*4882a593Smuzhiyun	both pf_enable and pf_retrans > path_max_retrans can disable pf state.
2401*4882a593Smuzhiyun	Since pf_retrans and path_max_retrans can be changed by userspace
2402*4882a593Smuzhiyun	application, sometimes user expects to disable pf state by the value of
2403*4882a593Smuzhiyun	pf_retrans > path_max_retrans, but occasionally the value of pf_retrans
2404*4882a593Smuzhiyun	or path_max_retrans is changed by the user application, this pf state is
2405*4882a593Smuzhiyun	enabled. As such, it is necessary to add this to dynamically enable
2406*4882a593Smuzhiyun	and disable pf state. See:
2407*4882a593Smuzhiyun	https://datatracker.ietf.org/doc/draft-ietf-tsvwg-sctp-failover for
2408*4882a593Smuzhiyun	details.
2409*4882a593Smuzhiyun
2410*4882a593Smuzhiyun	1: Enable pf.
2411*4882a593Smuzhiyun
2412*4882a593Smuzhiyun	0: Disable pf.
2413*4882a593Smuzhiyun
2414*4882a593Smuzhiyun	Default: 1
2415*4882a593Smuzhiyun
2416*4882a593Smuzhiyunpf_expose - INTEGER
2417*4882a593Smuzhiyun	Unset or enable/disable pf (pf is short for potentially failed) state
2418*4882a593Smuzhiyun	exposure.  Applications can control the exposure of the PF path state
2419*4882a593Smuzhiyun	in the SCTP_PEER_ADDR_CHANGE event and the SCTP_GET_PEER_ADDR_INFO
2420*4882a593Smuzhiyun	sockopt.   When it's unset, no SCTP_PEER_ADDR_CHANGE event with
2421*4882a593Smuzhiyun	SCTP_ADDR_PF state will be sent and a SCTP_PF-state transport info
2422*4882a593Smuzhiyun	can be got via SCTP_GET_PEER_ADDR_INFO sockopt;  When it's enabled,
2423*4882a593Smuzhiyun	a SCTP_PEER_ADDR_CHANGE event will be sent for a transport becoming
2424*4882a593Smuzhiyun	SCTP_PF state and a SCTP_PF-state transport info can be got via
2425*4882a593Smuzhiyun	SCTP_GET_PEER_ADDR_INFO sockopt;  When it's diabled, no
2426*4882a593Smuzhiyun	SCTP_PEER_ADDR_CHANGE event will be sent and it returns -EACCES when
2427*4882a593Smuzhiyun	trying to get a SCTP_PF-state transport info via SCTP_GET_PEER_ADDR_INFO
2428*4882a593Smuzhiyun	sockopt.
2429*4882a593Smuzhiyun
2430*4882a593Smuzhiyun	0: Unset pf state exposure, Compatible with old applications.
2431*4882a593Smuzhiyun
2432*4882a593Smuzhiyun	1: Disable pf state exposure.
2433*4882a593Smuzhiyun
2434*4882a593Smuzhiyun	2: Enable pf state exposure.
2435*4882a593Smuzhiyun
2436*4882a593Smuzhiyun	Default: 0
2437*4882a593Smuzhiyun
2438*4882a593Smuzhiyunaddip_noauth_enable - BOOLEAN
2439*4882a593Smuzhiyun	Dynamic Address Reconfiguration (ADD-IP) requires the use of
2440*4882a593Smuzhiyun	authentication to protect the operations of adding or removing new
2441*4882a593Smuzhiyun	addresses.  This requirement is mandated so that unauthorized hosts
2442*4882a593Smuzhiyun	would not be able to hijack associations.  However, older
2443*4882a593Smuzhiyun	implementations may not have implemented this requirement while
2444*4882a593Smuzhiyun	allowing the ADD-IP extension.  For reasons of interoperability,
2445*4882a593Smuzhiyun	we provide this variable to control the enforcement of the
2446*4882a593Smuzhiyun	authentication requirement.
2447*4882a593Smuzhiyun
2448*4882a593Smuzhiyun	== ===============================================================
2449*4882a593Smuzhiyun	1  Allow ADD-IP extension to be used without authentication.  This
2450*4882a593Smuzhiyun	   should only be set in a closed environment for interoperability
2451*4882a593Smuzhiyun	   with older implementations.
2452*4882a593Smuzhiyun
2453*4882a593Smuzhiyun	0  Enforce the authentication requirement
2454*4882a593Smuzhiyun	== ===============================================================
2455*4882a593Smuzhiyun
2456*4882a593Smuzhiyun	Default: 0
2457*4882a593Smuzhiyun
2458*4882a593Smuzhiyunauth_enable - BOOLEAN
2459*4882a593Smuzhiyun	Enable or disable Authenticated Chunks extension.  This extension
2460*4882a593Smuzhiyun	provides the ability to send and receive authenticated chunks and is
2461*4882a593Smuzhiyun	required for secure operation of Dynamic Address Reconfiguration
2462*4882a593Smuzhiyun	(ADD-IP) extension.
2463*4882a593Smuzhiyun
2464*4882a593Smuzhiyun	- 1: Enable this extension.
2465*4882a593Smuzhiyun	- 0: Disable this extension.
2466*4882a593Smuzhiyun
2467*4882a593Smuzhiyun	Default: 0
2468*4882a593Smuzhiyun
2469*4882a593Smuzhiyunprsctp_enable - BOOLEAN
2470*4882a593Smuzhiyun	Enable or disable the Partial Reliability extension (RFC3758) which
2471*4882a593Smuzhiyun	is used to notify peers that a given DATA should no longer be expected.
2472*4882a593Smuzhiyun
2473*4882a593Smuzhiyun	- 1: Enable extension
2474*4882a593Smuzhiyun	- 0: Disable
2475*4882a593Smuzhiyun
2476*4882a593Smuzhiyun	Default: 1
2477*4882a593Smuzhiyun
2478*4882a593Smuzhiyunmax_burst - INTEGER
2479*4882a593Smuzhiyun	The limit of the number of new packets that can be initially sent.  It
2480*4882a593Smuzhiyun	controls how bursty the generated traffic can be.
2481*4882a593Smuzhiyun
2482*4882a593Smuzhiyun	Default: 4
2483*4882a593Smuzhiyun
2484*4882a593Smuzhiyunassociation_max_retrans - INTEGER
2485*4882a593Smuzhiyun	Set the maximum number for retransmissions that an association can
2486*4882a593Smuzhiyun	attempt deciding that the remote end is unreachable.  If this value
2487*4882a593Smuzhiyun	is exceeded, the association is terminated.
2488*4882a593Smuzhiyun
2489*4882a593Smuzhiyun	Default: 10
2490*4882a593Smuzhiyun
2491*4882a593Smuzhiyunmax_init_retransmits - INTEGER
2492*4882a593Smuzhiyun	The maximum number of retransmissions of INIT and COOKIE-ECHO chunks
2493*4882a593Smuzhiyun	that an association will attempt before declaring the destination
2494*4882a593Smuzhiyun	unreachable and terminating.
2495*4882a593Smuzhiyun
2496*4882a593Smuzhiyun	Default: 8
2497*4882a593Smuzhiyun
2498*4882a593Smuzhiyunpath_max_retrans - INTEGER
2499*4882a593Smuzhiyun	The maximum number of retransmissions that will be attempted on a given
2500*4882a593Smuzhiyun	path.  Once this threshold is exceeded, the path is considered
2501*4882a593Smuzhiyun	unreachable, and new traffic will use a different path when the
2502*4882a593Smuzhiyun	association is multihomed.
2503*4882a593Smuzhiyun
2504*4882a593Smuzhiyun	Default: 5
2505*4882a593Smuzhiyun
2506*4882a593Smuzhiyunpf_retrans - INTEGER
2507*4882a593Smuzhiyun	The number of retransmissions that will be attempted on a given path
2508*4882a593Smuzhiyun	before traffic is redirected to an alternate transport (should one
2509*4882a593Smuzhiyun	exist).  Note this is distinct from path_max_retrans, as a path that
2510*4882a593Smuzhiyun	passes the pf_retrans threshold can still be used.  Its only
2511*4882a593Smuzhiyun	deprioritized when a transmission path is selected by the stack.  This
2512*4882a593Smuzhiyun	setting is primarily used to enable fast failover mechanisms without
2513*4882a593Smuzhiyun	having to reduce path_max_retrans to a very low value.  See:
2514*4882a593Smuzhiyun	http://www.ietf.org/id/draft-nishida-tsvwg-sctp-failover-05.txt
2515*4882a593Smuzhiyun	for details.  Note also that a value of pf_retrans > path_max_retrans
2516*4882a593Smuzhiyun	disables this feature. Since both pf_retrans and path_max_retrans can
2517*4882a593Smuzhiyun	be changed by userspace application, a variable pf_enable is used to
2518*4882a593Smuzhiyun	disable pf state.
2519*4882a593Smuzhiyun
2520*4882a593Smuzhiyun	Default: 0
2521*4882a593Smuzhiyun
2522*4882a593Smuzhiyunps_retrans - INTEGER
2523*4882a593Smuzhiyun	Primary.Switchover.Max.Retrans (PSMR), it's a tunable parameter coming
2524*4882a593Smuzhiyun	from section-5 "Primary Path Switchover" in rfc7829.  The primary path
2525*4882a593Smuzhiyun	will be changed to another active path when the path error counter on
2526*4882a593Smuzhiyun	the old primary path exceeds PSMR, so that "the SCTP sender is allowed
2527*4882a593Smuzhiyun	to continue data transmission on a new working path even when the old
2528*4882a593Smuzhiyun	primary destination address becomes active again".   Note this feature
2529*4882a593Smuzhiyun	is disabled by initializing 'ps_retrans' per netns as 0xffff by default,
2530*4882a593Smuzhiyun	and its value can't be less than 'pf_retrans' when changing by sysctl.
2531*4882a593Smuzhiyun
2532*4882a593Smuzhiyun	Default: 0xffff
2533*4882a593Smuzhiyun
2534*4882a593Smuzhiyunrto_initial - INTEGER
2535*4882a593Smuzhiyun	The initial round trip timeout value in milliseconds that will be used
2536*4882a593Smuzhiyun	in calculating round trip times.  This is the initial time interval
2537*4882a593Smuzhiyun	for retransmissions.
2538*4882a593Smuzhiyun
2539*4882a593Smuzhiyun	Default: 3000
2540*4882a593Smuzhiyun
2541*4882a593Smuzhiyunrto_max - INTEGER
2542*4882a593Smuzhiyun	The maximum value (in milliseconds) of the round trip timeout.  This
2543*4882a593Smuzhiyun	is the largest time interval that can elapse between retransmissions.
2544*4882a593Smuzhiyun
2545*4882a593Smuzhiyun	Default: 60000
2546*4882a593Smuzhiyun
2547*4882a593Smuzhiyunrto_min - INTEGER
2548*4882a593Smuzhiyun	The minimum value (in milliseconds) of the round trip timeout.  This
2549*4882a593Smuzhiyun	is the smallest time interval the can elapse between retransmissions.
2550*4882a593Smuzhiyun
2551*4882a593Smuzhiyun	Default: 1000
2552*4882a593Smuzhiyun
2553*4882a593Smuzhiyunhb_interval - INTEGER
2554*4882a593Smuzhiyun	The interval (in milliseconds) between HEARTBEAT chunks.  These chunks
2555*4882a593Smuzhiyun	are sent at the specified interval on idle paths to probe the state of
2556*4882a593Smuzhiyun	a given path between 2 associations.
2557*4882a593Smuzhiyun
2558*4882a593Smuzhiyun	Default: 30000
2559*4882a593Smuzhiyun
2560*4882a593Smuzhiyunsack_timeout - INTEGER
2561*4882a593Smuzhiyun	The amount of time (in milliseconds) that the implementation will wait
2562*4882a593Smuzhiyun	to send a SACK.
2563*4882a593Smuzhiyun
2564*4882a593Smuzhiyun	Default: 200
2565*4882a593Smuzhiyun
2566*4882a593Smuzhiyunvalid_cookie_life - INTEGER
2567*4882a593Smuzhiyun	The default lifetime of the SCTP cookie (in milliseconds).  The cookie
2568*4882a593Smuzhiyun	is used during association establishment.
2569*4882a593Smuzhiyun
2570*4882a593Smuzhiyun	Default: 60000
2571*4882a593Smuzhiyun
2572*4882a593Smuzhiyuncookie_preserve_enable - BOOLEAN
2573*4882a593Smuzhiyun	Enable or disable the ability to extend the lifetime of the SCTP cookie
2574*4882a593Smuzhiyun	that is used during the establishment phase of SCTP association
2575*4882a593Smuzhiyun
2576*4882a593Smuzhiyun	- 1: Enable cookie lifetime extension.
2577*4882a593Smuzhiyun	- 0: Disable
2578*4882a593Smuzhiyun
2579*4882a593Smuzhiyun	Default: 1
2580*4882a593Smuzhiyun
2581*4882a593Smuzhiyuncookie_hmac_alg - STRING
2582*4882a593Smuzhiyun	Select the hmac algorithm used when generating the cookie value sent by
2583*4882a593Smuzhiyun	a listening sctp socket to a connecting client in the INIT-ACK chunk.
2584*4882a593Smuzhiyun	Valid values are:
2585*4882a593Smuzhiyun
2586*4882a593Smuzhiyun	* md5
2587*4882a593Smuzhiyun	* sha1
2588*4882a593Smuzhiyun	* none
2589*4882a593Smuzhiyun
2590*4882a593Smuzhiyun	Ability to assign md5 or sha1 as the selected alg is predicated on the
2591*4882a593Smuzhiyun	configuration of those algorithms at build time (CONFIG_CRYPTO_MD5 and
2592*4882a593Smuzhiyun	CONFIG_CRYPTO_SHA1).
2593*4882a593Smuzhiyun
2594*4882a593Smuzhiyun	Default: Dependent on configuration.  MD5 if available, else SHA1 if
2595*4882a593Smuzhiyun	available, else none.
2596*4882a593Smuzhiyun
2597*4882a593Smuzhiyunrcvbuf_policy - INTEGER
2598*4882a593Smuzhiyun	Determines if the receive buffer is attributed to the socket or to
2599*4882a593Smuzhiyun	association.   SCTP supports the capability to create multiple
2600*4882a593Smuzhiyun	associations on a single socket.  When using this capability, it is
2601*4882a593Smuzhiyun	possible that a single stalled association that's buffering a lot
2602*4882a593Smuzhiyun	of data may block other associations from delivering their data by
2603*4882a593Smuzhiyun	consuming all of the receive buffer space.  To work around this,
2604*4882a593Smuzhiyun	the rcvbuf_policy could be set to attribute the receiver buffer space
2605*4882a593Smuzhiyun	to each association instead of the socket.  This prevents the described
2606*4882a593Smuzhiyun	blocking.
2607*4882a593Smuzhiyun
2608*4882a593Smuzhiyun	- 1: rcvbuf space is per association
2609*4882a593Smuzhiyun	- 0: rcvbuf space is per socket
2610*4882a593Smuzhiyun
2611*4882a593Smuzhiyun	Default: 0
2612*4882a593Smuzhiyun
2613*4882a593Smuzhiyunsndbuf_policy - INTEGER
2614*4882a593Smuzhiyun	Similar to rcvbuf_policy above, this applies to send buffer space.
2615*4882a593Smuzhiyun
2616*4882a593Smuzhiyun	- 1: Send buffer is tracked per association
2617*4882a593Smuzhiyun	- 0: Send buffer is tracked per socket.
2618*4882a593Smuzhiyun
2619*4882a593Smuzhiyun	Default: 0
2620*4882a593Smuzhiyun
2621*4882a593Smuzhiyunsctp_mem - vector of 3 INTEGERs: min, pressure, max
2622*4882a593Smuzhiyun	Number of pages allowed for queueing by all SCTP sockets.
2623*4882a593Smuzhiyun
2624*4882a593Smuzhiyun	min: Below this number of pages SCTP is not bothered about its
2625*4882a593Smuzhiyun	memory appetite. When amount of memory allocated by SCTP exceeds
2626*4882a593Smuzhiyun	this number, SCTP starts to moderate memory usage.
2627*4882a593Smuzhiyun
2628*4882a593Smuzhiyun	pressure: This value was introduced to follow format of tcp_mem.
2629*4882a593Smuzhiyun
2630*4882a593Smuzhiyun	max: Number of pages allowed for queueing by all SCTP sockets.
2631*4882a593Smuzhiyun
2632*4882a593Smuzhiyun	Default is calculated at boot time from amount of available memory.
2633*4882a593Smuzhiyun
2634*4882a593Smuzhiyunsctp_rmem - vector of 3 INTEGERs: min, default, max
2635*4882a593Smuzhiyun	Only the first value ("min") is used, "default" and "max" are
2636*4882a593Smuzhiyun	ignored.
2637*4882a593Smuzhiyun
2638*4882a593Smuzhiyun	min: Minimal size of receive buffer used by SCTP socket.
2639*4882a593Smuzhiyun	It is guaranteed to each SCTP socket (but not association) even
2640*4882a593Smuzhiyun	under moderate memory pressure.
2641*4882a593Smuzhiyun
2642*4882a593Smuzhiyun	Default: 4K
2643*4882a593Smuzhiyun
2644*4882a593Smuzhiyunsctp_wmem  - vector of 3 INTEGERs: min, default, max
2645*4882a593Smuzhiyun	Only the first value ("min") is used, "default" and "max" are
2646*4882a593Smuzhiyun	ignored.
2647*4882a593Smuzhiyun
2648*4882a593Smuzhiyun	min: Minimum size of send buffer that can be used by SCTP sockets.
2649*4882a593Smuzhiyun	It is guaranteed to each SCTP socket (but not association) even
2650*4882a593Smuzhiyun	under moderate memory pressure.
2651*4882a593Smuzhiyun
2652*4882a593Smuzhiyun	Default: 4K
2653*4882a593Smuzhiyun
2654*4882a593Smuzhiyunaddr_scope_policy - INTEGER
2655*4882a593Smuzhiyun	Control IPv4 address scoping - draft-stewart-tsvwg-sctp-ipv4-00
2656*4882a593Smuzhiyun
2657*4882a593Smuzhiyun	- 0   - Disable IPv4 address scoping
2658*4882a593Smuzhiyun	- 1   - Enable IPv4 address scoping
2659*4882a593Smuzhiyun	- 2   - Follow draft but allow IPv4 private addresses
2660*4882a593Smuzhiyun	- 3   - Follow draft but allow IPv4 link local addresses
2661*4882a593Smuzhiyun
2662*4882a593Smuzhiyun	Default: 1
2663*4882a593Smuzhiyun
2664*4882a593Smuzhiyun
2665*4882a593Smuzhiyun``/proc/sys/net/core/*``
2666*4882a593Smuzhiyun========================
2667*4882a593Smuzhiyun
2668*4882a593Smuzhiyun	Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.
2669*4882a593Smuzhiyun
2670*4882a593Smuzhiyun
2671*4882a593Smuzhiyun``/proc/sys/net/unix/*``
2672*4882a593Smuzhiyun========================
2673*4882a593Smuzhiyun
2674*4882a593Smuzhiyunmax_dgram_qlen - INTEGER
2675*4882a593Smuzhiyun	The maximum length of dgram socket receive queue
2676*4882a593Smuzhiyun
2677*4882a593Smuzhiyun	Default: 10
2678*4882a593Smuzhiyun
2679