1SHOREWALL-TCDEVICES(5)          [FIXME: manual]         SHOREWALL-TCDEVICES(5)
2
3
4

NAME

6       tcdevices - Shorewall Traffic Shaping Devices file
7

SYNOPSIS

9       /etc/shorewall/tcdevices
10

DESCRIPTION

12       Entries in this file define the bandwidth for interfaces on which you
13       want traffic shaping to be enabled.
14
15       If you do not plan to use traffic shaping for a device, don't put it in
16       here as it limits the throughput of that device to the limits you set
17       here.
18
19       A note on the bandwidth definitions used in this file:
20
21       ·   don't use a space between the integer value and the unit: 30kbit is
22           valid while 30 kbit is not.
23
24       ·   you can use one of the following units:
25
26           kbps
27               Kilobytes per second.
28
29           mbps
30               Megabytes per second.
31
32           kbit
33               Kilobits per second.
34
35           mbit
36               Megabits per second.
37
38           bps or number
39               Bytes per second.
40
41       ·   Only whole integers are allowed.
42
43       The columns in the file are as follows.
44
45       INTERFACE - [number:]interface
46           Name of interface. Each interface may be listed only once in this
47           file. You may NOT specify the name of an alias (e.g., eth0:0) here;
48           see http://www.shorewall.net/FAQ.htm#faq18
49
50           You may NOT specify wildcards here, e.g. if you have multiple ppp
51           interfaces, you need to put them all in here!
52
53           If the device doesn't exist, a warning message will be issued
54           during "shorewall [re]start" and "shorewall refresh" and traffic
55           shaping configuration will be skipped for that device.
56
57           Shorewall assigns a sequential interface number to each interface
58           (the first entry in the file is interface 1, the second is
59           interface 2 and so on) You can explicitly specify the interface
60           number by prefixing the interface name with the number and a colon
61           (":"). Example: 1:eth0.
62
63       IN-BANDWIDTH - bandwidth[:burst]
64           The incoming bandwidth of that interface. Please note that you are
65           not able to do traffic shaping on incoming traffic, as the traffic
66           is already received before you could do so. But this allows you to
67           define the maximum traffic allowed for this interface in total, if
68           the rate is exceeded, the packets are dropped. You want this mainly
69           if you have a DSL or Cable connection to avoid queuing at your
70           providers side.
71
72           If you don't want any traffic to be dropped, set this to a value to
73           zero in which case Shorewall will not create an ingress qdisc.Must
74           be set to zero if the REDIRECTED INTERFACES column is non-empty.
75
76           The optional burst option was added in Shorewall 4.4.18. The
77           default burst is 10kb. A larger burst can help make the bandwidth
78           more accurate; often for fast lines, the enforced rate is well
79           below the specified bandwidth.
80
81       OUT-BANDWIDTH - bandwidth
82           The outgoing bandwidth of that interface. This is the maximum speed
83           your connection can handle. It is also the speed you can refer as
84           "full" if you define the tc classes in shorewall-tcclasses[1](5).
85           Outgoing traffic above this rate will be dropped.
86
87       OPTIONS - {-|{classify|hfsc} ,...}
88           classify — When specified, Shorewall will not generate tc or
89           Netfilter rules to classify traffic based on packet marks. You must
90           do all classification using CLASSIFY rules in
91           shorewall-tcrules[2](5).
92
93           hfsc - Shorewall normally uses the Hierarchical Token Bucket
94           queuing discipline. When hfsc is specified, the Hierarchical Fair
95           Service Curves discipline is used instead.
96
97       REDIRECTED INTERFACES - [interface[,interface]...]
98           May only be specified if the interface in the INTERFACE column is
99           an Intermediate Frame Block (IFB) device. Causes packets that enter
100           each listed interface to be passed through the egress filters
101           defined for this device, thus providing a form of incoming traffic
102           shaping. When this column is non-empty, the classify option is
103           assumed.
104

EXAMPLES

106       Example 1:
107           Suppose you are using PPP over Ethernet (DSL) and ppp0 is the
108           interface for this. The device has an outgoing bandwidth of 500kbit
109           and an incoming bandwidth of 6000kbit
110
111                       #INTERFACE   IN-BANDWIDTH    OUT-BANDWIDTH         OPTIONS         REDIRECTED
112                       #                                                                  INTERFACES
113                       1:ppp0         6000kbit        500kbit
114

FILES

116       /etc/shorewall/tcdevices
117

SEE ALSO

119       http://shorewall.net/traffic_shaping.htm
120
121       shorewall(8), shorewall-accounting(5), shorewall-actions(5),
122       shorewall-blacklist(5), shorewall-hosts(5), shorewall_interfaces(5),
123       shorewall-ipsets(5), shorewall-maclist(5), shorewall-masq(5),
124       shorewall-nat(5), shorewall-netmap(5), shorewall-params(5),
125       shorewall-policy(5), shorewall-providers(5), shorewall-proxyarp(5),
126       shorewall-route_rules(5), shorewall-routestopped(5),
127       shorewall-rules(5), shorewall.conf(5), shorewall-secmarks(5),
128       shorewall-tcclasses(5), shorewall-tcrules(5), shorewall-tos(5),
129       shorewall-tunnels(5), shorewall-zones(5)
130

NOTES

132        1. shorewall-tcclasses
133           http://www.shorewall.net/manpages/shorewall-tcclasses.html
134
135        2. shorewall-tcrules
136           http://www.shorewall.net/manpages/shorewall-tcrules.html
137
138
139
140[FIXME: source]                   09/16/2011            SHOREWALL-TCDEVICES(5)
Impressum