-
Notifications
You must be signed in to change notification settings - Fork 759
/
TrafficShaper.xml
356 lines (356 loc) · 15.7 KB
/
TrafficShaper.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<model>
<mount>//OPNsense/TrafficShaper</mount>
<version>1.0.3</version>
<description>OPNsense traffic shaper</description>
<items>
<pipes>
<pipe type="ArrayField">
<number type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>65535</MaximumValue>
<ValidationMessage>Pipe number must be between 1...65535</ValidationMessage>
<Required>Y</Required>
</number>
<enabled type="BooleanField">
<Default>1</Default>
<Required>Y</Required>
</enabled>
<bandwidth type="IntegerField">
<Required>Y</Required>
<MinimumValue>1</MinimumValue>
<ValidationMessage>Bandwidth out of range</ValidationMessage>
</bandwidth>
<bandwidthMetric type="OptionField">
<Required>Y</Required>
<Default>Kbit</Default>
<OptionValues>
<bit>bit/s</bit>
<Kbit>kbit/s</Kbit>
<Mbit>Mbit/s</Mbit>
<Gbit>Gbit/s</Gbit>
</OptionValues>
<ValidationMessage>Bandwidth metric should be either bit/s, kbit/s, Mbit/s or Gbit/s</ValidationMessage>
</bandwidthMetric>
<queue type="IntegerField">
<MinimumValue>2</MinimumValue>
<MaximumValue>100</MaximumValue>
<ValidationMessage>queue size should be between 2...100</ValidationMessage>
</queue>
<mask type="OptionField">
<Required>Y</Required>
<Default>none</Default>
<OptionValues>
<none>(none)</none>
<src-ip>source</src-ip>
<dst-ip>destination</dst-ip>
</OptionValues>
</mask>
<buckets type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>65535</MaximumValue>
<ValidationMessage>bucket size should be between 1...65535</ValidationMessage>
</buckets>
<scheduler type="OptionField">
<BlankDesc>Weighted Fair Queueing</BlankDesc>
<OptionValues>
<fifo>FIFO</fifo>
<rr>Deficit Round Robin</rr>
<qfq>QFQ</qfq>
<fq_codel>FlowQueue-CoDel</fq_codel>
<fq_pie>FlowQueue-PIE</fq_pie>
</OptionValues>
</scheduler>
<codel_enable type="BooleanField">
<Default>0</Default>
<Required>Y</Required>
<Constraints>
<check001>
<ValidationMessage>CoDel and PIE can not be combined.</ValidationMessage>
<type>SingleSelectConstraint</type>
<addFields>
<pie_enable>pie_enable</pie_enable>
</addFields>
</check001>
</Constraints>
</codel_enable>
<codel_target type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>10000</MaximumValue>
</codel_target>
<codel_interval type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>10000</MaximumValue>
</codel_interval>
<codel_ecn_enable type="BooleanField">
<Default>0</Default>
<Required>Y</Required>
</codel_ecn_enable>
<pie_enable type="BooleanField">
<Default>0</Default>
<Required>Y</Required>
<Constraints>
<check001>
<reference>codel_enable.check001</reference>
</check001>
</Constraints>
</pie_enable>
<fqcodel_quantum type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>65535</MaximumValue>
</fqcodel_quantum>
<fqcodel_limit type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>65535</MaximumValue>
</fqcodel_limit>
<fqcodel_flows type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>65535</MaximumValue>
</fqcodel_flows>
<origin type="TextField">
<Mask>/^([a-z,A-Z,1-9]){0,30}$/</Mask>
<ValidationMessage>Origin should be regular text of max 30 characters</ValidationMessage>
</origin>
<delay type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>3000</MaximumValue>
<ValidationMessage>Please choose a value between 1 and 3000</ValidationMessage>
</delay>
<description type="DescriptionField">
<Required>Y</Required>
</description>
</pipe>
</pipes>
<queues>
<queue type="ArrayField">
<number type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>65535</MaximumValue>
<ValidationMessage>Queue number must be between 1...65535</ValidationMessage>
<Required>Y</Required>
</number>
<enabled type="BooleanField">
<Default>1</Default>
<Required>Y</Required>
</enabled>
<pipe type="ModelRelationField">
<Model>
<pipes>
<source>OPNsense.TrafficShaper.TrafficShaper</source>
<items>pipes.pipe</items>
<display>description</display>
</pipes>
</Model>
<ValidationMessage>Related pipe not found</ValidationMessage>
<Required>Y</Required>
</pipe>
<weight type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>100</MaximumValue>
<Default>100</Default>
<Required>Y</Required>
<ValidationMessage>Weight must be between 1...100</ValidationMessage>
</weight>
<mask type="OptionField">
<Required>Y</Required>
<Default>none</Default>
<OptionValues>
<none>(none)</none>
<src-ip>source</src-ip>
<dst-ip>destination</dst-ip>
</OptionValues>
</mask>
<buckets type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>65535</MaximumValue>
<ValidationMessage>bucket size should be between 1...65535</ValidationMessage>
</buckets>
<codel_enable type="BooleanField">
<Default>0</Default>
<Required>Y</Required>
<Constraints>
<check001>
<ValidationMessage>CoDel and PIE can not be combined.</ValidationMessage>
<type>SingleSelectConstraint</type>
<addFields>
<pie_enable>pie_enable</pie_enable>
</addFields>
</check001>
</Constraints>
</codel_enable>
<codel_target type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>10000</MaximumValue>
</codel_target>
<codel_interval type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>10000</MaximumValue>
</codel_interval>
<codel_ecn_enable type="BooleanField">
<Default>0</Default>
<Required>Y</Required>
</codel_ecn_enable>
<pie_enable type="BooleanField">
<Default>0</Default>
<Required>Y</Required>
<Constraints>
<check001>
<reference>codel_enable.check001</reference>
</check001>
</Constraints>
</pie_enable>
<description type="DescriptionField">
<Required>Y</Required>
</description>
<origin type="TextField">
<Mask>/^([a-z,A-Z,1-9]){0,30}$/</Mask>
<ValidationMessage>origin should be regular text of max 30 characters</ValidationMessage>
</origin>
</queue>
</queues>
<rules>
<rule type="ArrayField">
<enabled type="BooleanField">
<Default>1</Default>
<Required>Y</Required>
</enabled>
<sequence type="IntegerField">
<MinimumValue>1</MinimumValue>
<MaximumValue>1000000</MaximumValue>
<ValidationMessage>provide a valid sequence for sorting</ValidationMessage>
<Required>Y</Required>
<Default>1</Default>
</sequence>
<interface type="InterfaceField">
<Required>Y</Required>
<Default>wan</Default>
<AllowDynamic>Y</AllowDynamic>
<filters>
<enable>/^(?!0).*$/</enable>
</filters>
</interface>
<interface2 type="InterfaceField">
<AllowDynamic>Y</AllowDynamic>
<filters>
<enable>/^(?!0).*$/</enable>
</filters>
</interface2>
<proto type="OptionField">
<Required>Y</Required>
<Default>ip</Default>
<OptionValues>
<ip>ip</ip>
<ip4>ipv4</ip4>
<ip6>ipv6</ip6>
<udp>udp</udp>
<tcp>tcp</tcp>
<tcp_ack>tcp (ACK packets only)</tcp_ack>
<tcp_ack_not>tcp (non-ACK packets)</tcp_ack_not>
<icmp>icmp</icmp>
<ipv6_icmp value="ipv6-icmp">ipv6-icmp</ipv6_icmp>
<igmp>igmp</igmp>
<esp>esp</esp>
<ah>ah</ah>
<gre>gre</gre>
</OptionValues>
</proto>
<iplen type="IntegerField">
<MinimumValue>2</MinimumValue>
<MaximumValue>65535</MaximumValue>
<ValidationMessage>The absolute limitation for packet size is 64K (65535 bytes)</ValidationMessage>
</iplen>
<source type="NetworkField">
<Required>Y</Required>
<FieldSeparator>,</FieldSeparator>
<Default>any</Default>
<asList>Y</asList>
</source>
<source_not type="BooleanField">
<Default>0</Default>
<Required>Y</Required>
</source_not>
<src_port type="PortField">
<Required>Y</Required>
<EnableWellKnown>Y</EnableWellKnown>
<EnableRanges>Y</EnableRanges>
<Default>any</Default>
</src_port>
<destination type="NetworkField">
<Required>Y</Required>
<FieldSeparator>,</FieldSeparator>
<Default>any</Default>
<asList>Y</asList>
</destination>
<destination_not type="BooleanField">
<Default>0</Default>
<Required>Y</Required>
</destination_not>
<dst_port type="PortField">
<Required>Y</Required>
<EnableWellKnown>Y</EnableWellKnown>
<EnableRanges>Y</EnableRanges>
<Default>any</Default>
</dst_port>
<dscp type="OptionField">
<Multiple>Y</Multiple>
<OptionValues>
<be>Best Effort</be>
<ef>Expedited Forwarding</ef>
<af11>AF11</af11>
<af12>AF12</af12>
<af13>AF13</af13>
<af21>AF21</af21>
<af22>AF22</af22>
<af23>AF23</af23>
<af31>AF31</af31>
<af32>AF32</af32>
<af33>AF33</af33>
<af41>AF41</af41>
<af42>AF42</af42>
<af43>AF43</af43>
<cs1>CS1</cs1>
<cs2>CS2</cs2>
<cs3>CS3</cs3>
<cs4>CS4</cs4>
<cs5>CS5</cs5>
<cs6>CS6</cs6>
<cs7>CS7</cs7>
</OptionValues>
</dscp>
<direction type="OptionField">
<BlankDesc>both</BlankDesc>
<OptionValues>
<in>in</in>
<out>out</out>
</OptionValues>
</direction>
<target type="ModelRelationField">
<Model>
<pipes>
<source>OPNsense.TrafficShaper.TrafficShaper</source>
<items>pipes.pipe</items>
<display>description</display>
<filters>
<description>/(.){1,255}/</description>
</filters>
</pipes>
<queues>
<source>OPNsense.TrafficShaper.TrafficShaper</source>
<items>queues.queue</items>
<display>description</display>
<filters>
<description>/(.){1,255}/</description>
</filters>
</queues>
</Model>
<ValidationMessage>Related pipe or queue not found</ValidationMessage>
<Required>Y</Required>
</target>
<description type="DescriptionField"/>
<origin type="TextField">
<Mask>/^([a-z,A-Z,1-9]){0,30}$/</Mask>
<ValidationMessage>origin should be regular text of max 30 characters</ValidationMessage>
</origin>
</rule>
</rules>
</items>
</model>