~ubuntu-branches/ubuntu/precise/shorewall6/precise

« back to all changes in this revision

Viewing changes to configfiles/tcdevices.annotated

  • Committer: Bazaar Package Importer
  • Author(s): Roberto C. Sanchez
  • Date: 2011-06-07 20:42:53 UTC
  • mfrom: (1.3.21 upstream)
  • Revision ID: james.westby@ubuntu.com-20110607204253-shuyx4o2yvc7v9my
Tags: 4.4.20.1-1
* New Upstream Version
* New debconf translation, Brazilian Portugese, thanks to Eder L. Marques
  (Closes: #629115)

Show diffs side-by-side

added added

removed removed

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