1SHOREWALL-TCINTERFA(5) Configuration Files SHOREWALL-TCINTERFA(5)
2
3
4
6 tcinterfaces - Shorewall file
7
9 /etc/shorewall[6]/tcinterfaces
10
12 This file lists the interfaces that are subject to simple traffic
13 shaping. Simple traffic shaping is enabled by setting TC_ENABLED=Simple
14 in shorewall.conf[1](5).
15
16 A note on the bandwidth definition used in this file:
17
18 • don't use a space between the integer value and the unit: 30kbit is
19 valid while 30 kbit is not.
20
21 • you can use one of the following units:
22
23 kbps
24 Kilobytes per second.
25
26 mbps
27 Megabytes per second.
28
29 kbit
30 Kilobits per second.
31
32 mbit
33 Megabits per second.
34
35 bps or number
36 Bytes per second.
37
38 k or kb
39 Kilo bytes.
40
41 m or mb
42 Megabytes.
43
44 • Only whole integers are allowed.
45
46 The columns in the file are as follows (where the column name is
47 followed by a different name in parentheses, the different name is used
48 in the alternate specification syntax).
49
50 INTERFACE
51 The logical name of an interface. If you run both IPv4 and IPv6
52 Shorewall firewalls, a given interface should only be listed in one
53 of the two configurations.
54
55 TYPE - [external|internal]
56 Optional. If given specifies whether the interface is external
57 (facing toward the Internet) or internal (facing toward a local
58 network) and enables SFQ flow classification.
59
60 IN-BANDWIDTH (in_bandwidth) -
61 {-|bandwidth[:burst]|~bandwidth[:interval:decay_interval]}
62 The incoming bandwidth of that interface. Please note that you are
63 not able to do traffic shaping on incoming traffic, as the traffic
64 is already received before you could do so. But this allows you to
65 define the maximum traffic allowed for this interface in total, if
66 the rate is exceeded, the packets are dropped. You want this mainly
67 if you have a DSL or Cable connection to avoid queuing at your
68 providers side.
69
70 If you don't want any traffic to be dropped, set this to a value to
71 zero in which case Shorewall will not create an ingress qdisc.Must
72 be set to zero if the REDIRECTED INTERFACES column is non-empty.
73
74 The optional burst option was added in Shorewall 4.4.18. The
75 default burst is 10kb. A larger burst can help make the bandwidth
76 more accurate; often for fast lines, the enforced rate is well
77 below the specified bandwidth.
78
79 What is described above creates a rate/burst policing filter.
80 Beginning with Shorewall 4.4.25, a rate-estimated policing filter
81 may be configured instead. Rate-estimated filters should be used
82 with Ethernet adapters that have Generic Receive Offload enabled by
83 default. See Shorewall FAQ 97a[2].
84
85 To create a rate-estimated filter, precede the bandwidth with a
86 tilde ("~"). The optional interval and decay_interval determine how
87 often the rate is estimated and how many samples are retained for
88 estimating. Please see
89 http://ace-host.stuart.id.au/russell/files/tc/doc/estimators.txt
90 for details. If not specified, the default interval is 250ms and
91 the default decay_interval is 4sec.
92
93 OUT-BANDWIDTH (out_bandwidth) -
94 [rate[:[burst][:[latency][:[peek][:[minburst]]]]]]
95 Added in Shorewall 4.4.13. The terms are defined in tc-tbf(8).
96
97 Shorewall provides defaults as follows:
98 burst - 10kb
99 latency - 200ms
100 The remaining options are defaulted by tc(8).
101
103 /etc/shorewall/tcinterfaces
104
105 /etc/shorewall6/tcinterfaces
106
108 http://ace-host.stuart.id.au/russell/files/tc/doc/sch_tbf.txt
109
110 http://ace-host.stuart.id.au/russell/files/tc/doc/estimators.txt
111
112 shorewall(8)
113
115 1. shorewall.conf
116 https://shorewall.org/manpages/shorewall.conf.html
117
118 2. Shorewall FAQ 97a
119 https://shorewall.org/FAQ.htm#faq97a
120
121
122
123Configuration Files 09/24/2020 SHOREWALL-TCINTERFA(5)