Name

tcdevices — Shorewall Traffic Shaping Devices file

Synopsis

/etc/shorewall/tcdevices

Description

Entries in this file define the bandwidth for interfaces on which you want traffic shaping to be enabled.

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.

A note on the bandwidth definitions used in this file:

  • don't use a space between the integer value and the unit: 30kbit is valid while 30 kbit is not.

  • you can use one of the following units:

    kpbs

    Kilobytes per second.

    mbps

    Megabytes per second.

    kbit

    Kilobits per second.

    mbit

    Megabits per second.

    bps or number

    Bytes per second.

  • Only whole integers are allowed.

The columns in the file are as follows.

INTERFACE - [number:]interface

Name of interface. 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 http://www.shorewall.net/FAQ.htm#faq18

You may NOT specify wildcards here, e.g. if you have multiple ppp interfaces, you need to put them all in here!

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.

Shorewall assigns a sequential interface number to each interface (the first entry in the file is interface 1, the second is interface 2 and so on) Beginning with Shorewall-perl 4.1.6, you can explicitly specify the interface number by prefixing the interface name with the number and a colon (":"). Example: 1:eth0.

IN-BANDWIDTH - bandwidth

The incoming bandwidth 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.

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.Must be set to zero if the REDIRECTED INTERFACES column is non-empty.

OUT-BANDWIDTH - bandwidth

The outgoing bandwidth 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 shorewall-tcclasses(5). Outgoing traffic above this rate will be dropped.

OPTIONS - {-|classify}

classify ― When specified, Shorewall will not generate tc or Netfilter rules to classify traffic based on packet marks. You must do all classification using CLASSIFY rules in shorewall-tcrules(5).

REDIRECTED INTERFACES - [interface[,interface]...]

Added in Shorewall-perl 4.1.6. May only be specified if the interface in the INTERFACE column is an Intermediate Frame Block (IFB) device. Causes packets that enter each listed interface to be passed through the egress filters defined for this device, thus providing a form of incoming traffic shaping. When this column is non-empty, the classify option is assumed.

Examples

Example 1:

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

        #INTERFACE   IN-BANDWIDTH    OUT-BANDWIDTH         OPTIONS         REDIRECTED
        #                                                                  INTERFACES
        1:ppp0         6000kbit        500kbit

FILES

/etc/shorewall/tcdevices

See ALSO

http://shorewall.net/traffic_shaping.htm

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)