<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>shorewall-tcdevices</title><link rel="stylesheet" href="html.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="id257171"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tcdevices — Shorewall Traffic Shaping Devices file</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">/etc/shorewall/tcdevices</code> </p></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id257202"></a><h2>Description</h2><p>Entries in this file define the bandwidth for interfaces on which
you want traffic shaping to be enabled.</p><p>If you do not plan to use traffic shaping for a device, don't put it
in here as it limits the troughput of that device to the limits you set
here.</p><p>A note on the <span class="emphasis"><em>bandwidth</em></span> definitions used in
this file:</p><div class="itemizedlist"><ul type="disc"><li><p>don't use a space between the integer value and the unit: 30kbit
is valid while 30 kbit is not.</p></li><li><p>you can use one of the following units:</p><div class="variablelist"><dl><dt><span class="term"><span class="bold"><strong>kpbs</strong></span></span></dt><dd><p>Kilobytes per second.</p></dd><dt><span class="term"><span class="bold"><strong>mbps</strong></span></span></dt><dd><p>Megabytes per second.</p></dd><dt><span class="term"><span class="bold"><strong>kbit</strong></span></span></dt><dd><p>Kilobits per second.</p></dd><dt><span class="term"><span class="bold"><strong>mbit</strong></span></span></dt><dd><p>Megabits per second.</p></dd><dt><span class="term"><span class="bold"><strong>bps</strong></span> or <span class="bold"><strong>number</strong></span></span></dt><dd><p>Bytes per second.</p></dd></dl></div></li><li><p>Only whole integers are allowed.</p></li></ul></div><p>The columns in the file are as follows.</p><div class="variablelist"><dl><dt><span class="term"><span class="bold"><strong>INTERFACE</strong></span> -
<span class="emphasis"><em>interface</em></span></span></dt><dd><p>Name of <span class="emphasis"><em>interface</em></span>. Each interface may be
listed only once in this file. You may NOT specify the name of an
alias (e.g., eth0:0) here; see <a class="ulink" href="http://www.shorewall.net/FAQ.htm#faq18" target="_self">http://www.shorewall.net/FAQ.htm#faq18</a></p><p>You may NOT specify wildcards here, e.g. if you have multiple
ppp interfaces, you need to put them all in here!</p><p>If the device doesn't exist, a warning message will be issued
during "shorewall [re]start" and "shorewall refresh" and traffic
shaping configuration will be skipped for that device.</p></dd><dt><span class="term"><span class="bold"><strong>IN-BANDWIDTH</strong></span> -
<span class="emphasis"><em>bandwidth</em></span></span></dt><dd><p>The incoming <span class="emphasis"><em>bandwidth</em></span> of that interface.
Please note that you are not able to do traffic shaping on incoming
traffic, as the traffic is already received before you could do so.
But this allows you to define the maximum traffic allowed for this
interface in total, if the rate is exceeded, the packets are
dropped. You want this mainly if you have a DSL or Cable connection
to avoid queuing at your providers side.</p><p>If you don't want any traffic to be dropped, set this to a
value to zero in which case Shorewall will not create an ingress
qdisc.</p></dd><dt><span class="term"><span class="bold"><strong>OUT-BANDWIDTH</strong></span> -
<span class="emphasis"><em>bandwidth</em></span></span></dt><dd><p>The outgoing <span class="emphasis"><em>bandwidth</em></span> of that interface.
This is the maximum speed your connection can handle. It is also the
speed you can refer as "full" if you define the tc classes in <a class="ulink" href="shorewall-tcclasses.html" target="_self">shorewall-tcclasses</a>(5).
Outgoing traffic above this rate will be dropped.</p><p></p></dd></dl></div><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This file is currently limited to ten (10) entries. Additional
entries will cause run-time errors in the generated firewall
script.</p></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id257455"></a><h2>Examples</h2><div class="variablelist"><dl><dt><span class="term">Example 1:</span></dt><dd><p>Suppose you are using PPP over Ethernet (DSL) and ppp0 is the
interface for this. The device has an outgoing bandwidth of 500kbit
and an incoming bandwidth of 6000kbit</p><pre class="programlisting"> #INTERFACE IN-BANDWIDTH OUT-BANDWIDTH
ppp0 6000kbit 500kbit</pre></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id257484"></a><h2>FILES</h2><p>/etc/shorewall/tcdevices</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id257493"></a><h2>See ALSO</h2><p><a class="ulink" href="http://shorewall.net/traffic_shaping.htm" target="_self">http://shorewall.net/traffic_shaping.htm</a></p><p>shorewall(8), shorewall-accounting(5), shorewall-actions(5),
shorewall-blacklist(5), shorewall-hosts(5), shorewall-interfaces(5),
shorewall-ipsec(5), shorewall-maclist(5), shorewall-masq(5),
shorewall-nat(5), shorewall-netmap(5), shorewall-params(5),
shorewall-policy(5), shorewall-providers(5), shorewall-proxyarp(5),
shorewall-route_rules(5), shorewall-routestopped(5), shorewall-rules(5),
shorewall.conf(5), shorewall-tcclasses(5), shorewall-tcrules(5),
shorewall-tos(5), shorewall-tunnels(5), shorewall-zones(5)</p></div></div></body></html>
