summaryrefslogtreecommitdiff
path: root/docs/ch10-qos.rst
blob: a6faf0c08e749c9a0d1a7a21521c873cb2987cf6 (plain)
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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
QoS and Traffic Policy
======================

VyOS uses tc_ as backend for QoS. VyOS provides its users with configuration
nodes for the following shaping/queueing/policing disciplines:

* HTB
* HFSC
* SFQ
* pfifo
* network-emulator
* PRIO
* GRED
* TBF
* DRR

VyOS QoS configuration is done in two steps. The first one consists in setting
up your classes/queues and traffic filters to distribute traffic amongst them.
The second step is to apply such traffic policy to an interface ingress or
egress.

Creating a traffic policy
-------------------------

Such configuration takes place under the `traffic-policy` tree.

Available subtrees :

.. code-block:: sh

  set traffic-policy drop-tail NAME
  set traffic-policy fair-queue NAME
  set traffic-policy limiter NAME
  set traffic-policy network-emulator NAME
  set traffic-policy priority-queue NAME
  set traffic-policy random-detect NAME
  set traffic-policy rate-control NAME
  set traffic-policy round-robin NAME
  set traffic-policy shaper NAME
  set traffic-policy shaper-hfsc NAME

Apply traffic policy to an interface
------------------------------------

Once a traffic-policy is created, you can apply it to an interface :

.. code-block:: sh

  set interfaces ethernet eth0 traffic-policy in WAN-IN
  set interfaces etherhet eth0 traffic-policy out WAN-OUT

Traffic policies in VyOS
------------------------
An overview of QoS traffic policies supported by VyOS.

Drop-tail (FIFO)
^^^^^^^^^^^^^^^^

A packet queuing mechanism on a FIFO (First In, First Out) basis; packets are
sent out in the same order as they arrive. The queue has a defined length,
packets arriving after the queue is filled up will be dropped (hence the name
`drop tail`, the "tail" of the queue will be dropped). With this policy in
place, all traffic is treated equally and put into a single queue. Applicable
to outbound traffic only.

Available commands:

* Define a drop-tail policy (unique name, exclusive to this policy):
  :code:`set traffic-policy drop-tail <policy name>`

* Add a description:
  :code:`set traffic-policy drop-tail <policy name> description <description>`

* Set the queue length limit (max. number of packets in queue), range
  0...4294967295 packets: :code:`set traffic-policy drop-tail <policy name>
  queue-limit <limit>`

Fair queue (SFQ)
^^^^^^^^^^^^^^^^

Fair queue is a packet queuing mechanism that separates traffic flows based on
their source/destination IP addresses and/or source port and places them into
buckets. Bandwidth is allocated fairly between buckets based on the Stochastic
airness Queuing algorithm. Applicable to outbound traffic only.

Available commands:

* Define a fair queue policy:
  :code:`set traffic-policy fair-queue <policy name>`

* Add a description:
  :code:`set traffic-policy fair-queue <policy name> description <description>`

* Set hash update interval; the algorithm used is stochastic and thus not
  'truly' fair, hash collisions can occur, in which case traffic flows may be
  put into the same bucket. To mitigate this, the hashes can be updated at a
  set interval, Range 0...4294967295 seconds: :code:`set traffic-policy
  fair-queue <policy name> hash-interval <seconds>`

* Set the queue-limit (max. number of packets in queue), range 0...4294967295
  packets, default 127: :code:`set traffic-policy fair-queue <policy name>
  queue-limit <limit>`

Limiter
^^^^^^^

The limiter performs ingress policing of traffic flows. Multiple classes of
traffic can be defined and traffic limits can be applied to each class. Traffic
exceeding the defined bandwidth limits is dropped. Applicable to inbound
traffic only.

Available commands:

* Define a traffic limiter policy:
  :code:`set traffic-policy limiter <policy-name>`
* Add a description:
  :code:`set traffic-policy limiter <policy-name> description <description>`

Traffic classes
^^^^^^^^^^^^^^^

* Define a traffic class for a limiter policy, range for class ID is 1...4095:
  :code:`set traffic-policy limiter <policy-name> class <class ID>`
* Add a class description:
  :code:`set traffic-policy limiter <policy-name> class <class ID> description
  <description>`
* Specify a bandwidth limit for a class, in kbit/s:
  :code:`set traffic-policy limiter <policy-name> class <class ID> bandwidth
  <rate>`. Available suffixes:

 * kbit (kilobits per second, default)
 * mbit (megabits per second)
 * gbit (gigabits per second)
 * kbps (kilobytes per second)
 * mbps (megabytes per second)
 * gbps (gigabytes per second)

* Set a burst size for a class, the maximum amount of traffic that can be sent,
  in bytes: :code:`set traffic-policy limiter <policy-name> class <class ID>
  burst <burst-size>`. Available suffixes:

 * kb (kilobytes)
 * mb (megabytes)
 * gb (gigabytes)

Default class
^^^^^^^^^^^^^

* Define a default class for a limiter policy that applies to traffic not
  matching any other classes for this policy: :code:`set traffic-policy limiter
  <policy name> default`

* Specify a bandwidth limit for the default class, in kbit/s: :code:`set
  traffic-policy limiter <policy name> default bandwidth <rate>`. Available
  suffixes:

 * kbit (kilobits per second, default)
 * mbit (megabits per second)
 * gbit (gigabits per second)
 * kbps (kilobytes per second)
 * mbps (megabytes per second)
 * gbps (gigabytes per second)

* Set a burst size for the default class, the maximum amount of traffic that
  can be sent, in bytes: :code:`set traffic-policy limiter <policy-name>
  default burst <burst-size>`. Available suffixes:

 * kb (kilobytes)
 * mb (megabytes)
 * gb (gigabytes)

* Specify the priority of the default class to set the order in which the rules
  are evaluated, the higher the number the lower the priority, range 0...20
  (default 20): :code:`set traffic-policy limiter <policy name> default
  priority <priority>`

Matching rules
^^^^^^^^^^^^^^

* Define a traffic class matching rule:
  :code:`set traffic-policy limiter <policy name> class <class ID> match
  <match name>`

* Add a description:
  :code:`set traffic-policy limiter <policy name> class <class ID> match
  <match name> description <description>`

* Specify the priority of a matching rule to set the order in which the rules
  are evaluated, the higher the number the lower the priority, range 0...20
  (default 20): :code:`set traffic-policy limiter <policy name> class
  <class ID> priority <priority>`

* Specify a match criterion based on a **destination MAC address**
  (format: xx:xx:xx:xx:xx:xx): :code:`set traffic-policy limiter <policy name>
  class <class ID> match <match name> ether destination <MAC address>`

* Specify a match criterion based on a **source MAC address** (format:
  xx:xx:xx:xx:xx:xx): :code:`set traffic-policy limiter <policy name> class
  <class ID> match <match name> ether source <MAC address>`

* Specify a match criterion based on **packet type/protocol**, range 0...65535:
  :code:`set traffic-policy limiter <policy name> class <class ID> match
  <match name> ether protocol <number>`

* Specify a match criterion based on the **fwmark field**, range 0....4294967295:
  :code:`set traffic-policy limiter <policy name> class <class ID> match
  <match name> mark <fwmark>`

* Specify a match criterion based on **VLAN ID**, range 1...4096:
  :code:`set traffic-policy limiter <policy name> class <class ID> match
  <match name> vif <VLAN ID>`

**IPv4**

* Specify a match criterion based on **destination IPv4 address** and/or port,
  port may be specified as number or service name (i.e. ssh): :code:`set
  traffic-policy limiter <policy name> class <class ID> match <match name> ip
  destination <IPv4 address|port>`

* Specify a match criterion based on **source IPv4 address** and/or port, port
  may be specified as number or service name (i.e. ssh): :code:`set
  traffic-policy limiter <policy name> class <class ID> match <match name> ip
  source <IPv4 address|port>`

* Specify a match criterion based on **DSCP (Differentiated Services Code Point)
  value**, DSCP value may be specified as decimal or hexadecimal number:
  :code:`set traffic-policy limiter <policy name> class <class ID> match
  <match name> ip dscp <DSCP value>`

* Specify a match criterion based on **IPv4 protocol**, protocol may be
  specified by name (i.e. icmp) or IANA-assigned number: :code:`set
  traffic-policy limiter <policy name> class <class ID> match <match name> ip
  protocol <proto>`

**IPv6**

* Specify a match criterion based on **destination IPv6 address and/or port**,
  port may be specified as number or service name (i.e. ssh): :code:`set
  traffic-policy limiter <policy name> class <class ID> match <match name>
  ipv6 destination <IPv6 address|port>`

* Specify a match criterion based on **source IPv6 address and/or port**, port
  may be specified as number or service name (i.e. ssh): :code:`set
  traffic-policy limiter <policy name> class <class ID> match <match name>
  ipv6 source <IPv6 address|port>`

* Specify a match criterion based on **DSCP (Differentiated Services Code
  Point) value**, DSCP value may be specified as decimal or hexadecimal number:
  :code:`set traffic-policy limiter <policy name> class <class ID> match
  <match name> ipv6 dscp <DSCP value>`

* Specify a match criterion based on **IPv6 protocol**, protocol may be
  specified by name (i.e. icmp) or IANA-assigned number: :code:`set
  traffic-policy limiter <policy name> class <class ID> match <match name>
  ipv6 protocol <proto>`

Network emulator
^^^^^^^^^^^^^^^^

The network emulator policy emulates WAN traffic, which is useful for testing
purposes. Applicable to outbound traffic only.

Available commands:

* Define a network emulator policy:
  :code:`set traffic-policy network-emulator <policy name>`

* Add a description:
  :code:`set traffic-policy network-emulator <policy name> description <description>`

* Specify a bandwidth limit in kbit/s:
  :code:`set traffic-policy network-emulator <policy name> bandwidth <rate>`
  Available suffixes:

 * kbit (kilobits per second, default)
 * mbit (megabits per second)
 * gbit (gigabits per second)
 * kbps (kilobytes per second)
 * mbps (megabytes per second)
 * gbps (gigabytes per second)

* Set a burst size, the maximum amount of traffic that can be sent, in bytes:
  :code:`set traffic-policy network-emulator <policy name> burst <burst size>`
  Available suffixes:

 * kb (kilobytes)
 * mb (megabytes)
 * gb (gigabytes)

* Define a delay between packets:
  :code:`set traffic-policy network-emulator <policy name> network-delay <delay>`
  Available suffixes:

 * secs (seconds)
 * ms (milliseconds, default)
 * us (microseconds)

* Set a percentage of corrupted of packets (one bit flip, unchanged checksum):
  :code:`set traffic-policy network-emulator <policy name> packet-corruption
  <percent>`

* Set a percentage of random packet loss:
  :code:`set traffic-policy network-emulator <policy name> packet-loss <percent>`

* Set a percentage of packets for random reordering:
  :code:`set traffic-policy network-emulator <policy name> packet-reordering
  <percent>`

* Set a queue length limit in packets, range 0...4294967295, default 127:
  :code:`set traffic-policy network-emulator <policy name> queue-limit <limit>`

Priority queue
^^^^^^^^^^^^^^

Up to seven queues with differing priorities can be defined, packets are placed
into queues based on associated match criteria. Packets are transmitted from
the queues in priority order. If queues with a higher order are being filled
with packets continuously, packets from lower priority queues will only be
transmitted after traffic volume from higher priority queues decreases.

Available commands:

* Define a priority queue:
  :code:`set traffic-policy priority-queue <policy name>`

* Add a description:
  :code:`set traffic-policy priority-queue <policy name> description <description>`

Traffic classes
***************

* Define a traffic class, each class is a separate queue, range for class ID
  is 1...7, while 1 being the lowest priority: :code:`set traffic-policy
  priority-queue <policy name> class <class ID>`

* Add a class description: :code:`set traffic-policy priority-queue
  <policy name> class <class ID> description <description>`

* Set a queue length limit in packets, default 1000:
  :code:`set traffic-policy priority-queue <policy name> class <class ID>
  queue-limit <limit>`

* Specify a queue type for a traffic class, available queue types:

 * drop-tail
 * fair-queue
 * random-detect

  :code:`set traffic-policy priority-queue <policy name> class <class ID>
  queue-type <type>`

**Default class**

* Define a default priority queue:
  :code:`set traffic-policy priority-queue <policy name> default`

* Define a maximum queue length for the default traffic class in packets:
  :code:`set traffic-policy priority-queue <policy name> default queue-limit
  <limit>`

* Specify the queuing type for the default traffic class, available queue types:

 * drop-tail
 * fair-queue
 * random-detect

  :code:`set traffic-policy priority-queue <policy name> default queue-type <type>`

Matching rules
^^^^^^^^^^^^^^

* Define a class matching rule:
  :code:`set traffic-policy priority-queue <policy name> class <class ID> match
  <match name>`

* Add a match rule description:
  :code:`set traffic-policy priority-queue <policy name> class <class ID> match
  <match name> description <description>`

* Specify a match criterion based on a **destination MAC address**
  (format: xx:xx:xx:xx:xx:xx): :code:`set traffic-policy priority-queue
  <policy name> class <class ID> match <match name> ether destination
  <MAC address>`

* Specify a match criterion based on a **source MAC address**
  (format: xx:xx:xx:xx:xx:xx): :code:`set traffic-policy priority-queue
  <policy name> class <class ID> match <match name> ether source <MAC address>`

* Specify a match criterion based on **packet type/protocol**, range 0...65535:
  :code:`set traffic-policy priority-queue <policy name> class <class ID> match
  <match name> ether protocol <number>`

* Specify a match criterion based on **ingress interface**:
  :code:`set traffic-policy priority-queue <policy name> class <class ID> match
  <match name> interface <interface>`

* Specify a match criterion based on the **fwmark field**, range 0....4294967295:
  :code:`set traffic-policy priority-queue <policy name> class <class ID> match
  <match name> mark <fwmark>`

* Specify a match criterion based on **VLAN ID**, range 1...4096:
  :code:`set traffic-policy priority-queue <policy name> class <class ID> match
  <match name> vif <VLAN ID>`

**IPv4**

* Specify a match criterion based on **destination IPv4 address and/or port**,
  port may be specified as number or service name (i.e. ssh): :code:`set
  traffic-policy priority-queue <policy name> class <class ID> match
  <match name> ip destination <IPv4 address|port>`

* Specify a match criterion based on **source IPv4 address and/or port**, port
  may be specified as number or service name (i.e. ssh): :code:`set
  traffic-policy priority-queue <policy name> class <class ID> match
  <match name> ip source <IPv4 address|port>`

* Specify a match criterion based on **DSCP (Differentiated Services Code Point)
  value**, DSCP value may be specified as decimal or hexadecimal number:
  :code:`set traffic-policy priority-queue <policy name> class <class ID> match
  <match name> ip dscp <DSCP value>`

* Specify a match criterion based on **IPv4 protocol**, protocol may be
  specified by name (i.e. icmp) or IANA-assigned number: :code:`set
  traffic-policy priority-queue <policy name> class <class ID> match
  <match name> ip protocol <proto>`

**IPv6**

* Specify a match criterion based on **destination IPv6 address and/or port**,
  port may be specified as number or service name (i.e. ssh): :code:`set
  traffic-policy priority-queue <policy name> class <class ID> match
  <match name> ipv6 destination <IPv6 address|port>`

* Specify a match criterion based on **source IPv6 address and/or port**, port
  may be specified as number or service name (i.e. ssh): :code:`set
  traffic-policy priority-queue <policy name> class <class ID> match
  <match name> ipv6 source <IPv6 address|port>`

* Specify a match criterion based on **DSCP (Differentiated Services Code Point)
  value**, DSCP value may be specified as decimal or hexadecimal number:
  :code:`set traffic-policy priority-queue <policy name> class <class ID> match
  <match name> ipv6 dscp <DSCP value>`

* Specify a match criterion based on **IPv6 protocol**, protocol may be
  specified by name (i.e. icmp) or IANA-assigned number: :code:`set
  traffic-policy priority-queue <policy name> class <class ID> match
  <match name> ipv6 protocol <proto>`

Random Early Detection (RED/WRED)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

RED
***

A Random Early Detection (RED) policy starts randomly dropping packets from a
queue before it reaches its queue limit thus avoiding congestion. It is also
beneficial for TCP connections as the gradual dropping of packets acts as a
signal for the sender to decrease its transmission rate, avoiding global TCP
synchronisation. Applicable to outbound traffic only.

Available commands:

* Define a RED policy:
  :code:`set traffic-policy random-detect <policy name>`

* Add a description:
  :code:`set traffic-policy random-detect <policy name> description <description>`

* Set a bandwidth limit, default auto:
  :code:`set traffic-policy random-detect <policy name> bandwidth <rate>`
  Available suffixes:</u>

 * auto (bandwidth limit based on interface speed, default)
 * kbit (kilobits per second)
 * mbit (megabits per second)
 * gbit (gigabits per second)
 * kbps (kilobytes per second)
 * mbps (megabytes per second)
 * gbps (gigabytes per second)

WRED
****

In contrast to RED, Weighted Random Early Detection (WRED) differentiates
between classes of traffic in a single queue and assigns different precedence
to traffic flows accordingly; low priority packets are dropped from a queue
earlier than high priority packets. This is achieved by using the first three
bits of the ToS (Type of Service) field to categorise data streams and in
accordance with the defined precedence parameters a decision is made. A WRED
policy is defined with the following parameters:

* precedence
* min-threshold
* max-threshold
* average-packet
* mark-probability
* queue-limit

If the average queue size is lower than the :code:`min-threshold`, an arriving
packet is placed in the queue. If the average queue size is between
:code:`min-threshold` and :code:`max-threshold` an arriving packet is either
dropped or placed in the queue depending on the defined :code:`mark-probability`.
In case the average queue size is larger than :code:`max-threshold`, packets
are dropped. If the current queue size is larger than :code:`queue-limit`,
packets are dropped. The average queue size depends on its former average size
and its current size. If :code:`max-threshold` is set but :code:`min-threshold`
is not, then :code:`min-threshold` is scaled to 50% of :code:`max-threshold`.
In principle, values must be :code:`min-threshold` < :code:`max-threshold` <
:code:`queue-limit`. Applicable to outbound traffic only.

Possible values for WRED parameters:

* precedence - IP precedence, first three bits of the ToS field as defined in
  RFC791_.

 +------------+----------------------+
 | Precedence |      Priority        |
 +============+======================+
 |      7     | Network Control      |
 +------------+----------------------+
 |      6     | Internetwork Control |
 +------------+----------------------+
 |      5     | CRITIC/ECP           |
 +------------+----------------------+
 |      4     | Flash Override       |
 +------------+----------------------+
 |      3     | Flash                |
 +------------+----------------------+
 |      2     | Immediate            |
 +------------+----------------------+
 |      1     | Priority             |
 +------------+----------------------+
 |      0     | Routine              |
 +------------+----------------------+

* min-threshold - Min value for the average queue length, packets are dropped
  if the average queue length reaches this threshold. Range 0...4096, default
  is dependent on precedence:

 +------------+-----------------------+
 | Precedence | default min-threshold |
 +============+=======================+
 |      7     |         16            |
 +------------+-----------------------+
 |      6     |         15            |
 +------------+-----------------------+
 |      5     |         14            |
 +------------+-----------------------+
 |      4     |         13            |
 +------------+-----------------------+
 |      3     |         12            |
 +------------+-----------------------+
 |      2     |         11            |
 +------------+-----------------------+
 |      1     |         10            |
 +------------+-----------------------+
 |      0     |          9            |
 +------------+-----------------------+

* max-threshold - Max value for the average queue length, packets are dropped
  if this value is exceeded. Range 0...4096 packets, default 18.

* average-packet - Average packet size in bytes, default 1024.

* mark-probability - The fraction of packets (n/probability) dropped from the
  queue when the average queue length reaches <code>max-threshold</code>,
  default 10.

* queue-limit - Packets are dropped when the current queue length reaches this
  value, default 4*<code>max-threshold</code>.

Usage:
:code:`set traffic-policy random-detect <policy-name> precedence
<precedence> [average-packet <bytes> | mark-probability <probability> |
max-threshold <max> | min-threshold <min> | queue-limit <packets>]`

Rate control (TBF)
^^^^^^^^^^^^^^^^^^

The rate control policy uses the Token Bucket Filter (TBF_) algorithm to limit
the packet flow to a set rate. Short bursts can be allowed to exceed the limit.
Applicable to outbound traffic only.

Available commands:

* Define a rate control policy:
  :code:`set traffic-policy rate-control <policy-name>`

* Add a description:
  :code:`set traffic-policy rate-control <policy-name> description <description>`

* Specify a bandwidth limit in kbits/s:
  :code:`set traffic-policy rate-control <policy-name> bandwidth <rate>`
  Available suffixes:</u>

 * kbit (kilobits per second, default)
 * mbit (megabits per second)
 * gbit (gigabits per second)
 * kbps (kilobytes per second)
 * mbps (megabytes per second)
 * gbps (gigabytes per second)

* Specify a burst size in bytes, default 15 kilobytes:
  :code:`set traffic-policy rate-control <policy-name> burst <burst-size>`
  Available suffixes:

 * kb (kilobytes)
 * mb (megabytes)
 * gb (gigabytes)

* Specify a latency in milliseconds; the maximum amount of time packets are
  allowed to wait in the queue, default 50 milliseconds:
  :code:`set traffic-policy rate-control <policy-name> latency`
  Available suffixes:

 * secs (seconds)
 * ms (milliseconds, default)
 * us (microseconds)

Round robin (DRR)
^^^^^^^^^^^^^^^^^

The round robin policy divides available bandwidth between all defined traffic
classes.

Available commands:

* Define a round robin policy:
  :code:`set traffic-policy round-robin <policy-name>`

* Add a description:
  :code:`set traffic-policy round-robin <policy-name> description <description>`

* Define a traffic class ID, range 2...4095:
  :code:`set traffic-policy round-robin <policy-name> class <class>`

**Default policy:**

* Define a default priority queue:
  :code:`set traffic-policy round-robin <policy name> default`

* Set the number of packets that can be sent per scheduling quantum:
  :code:`set traffic-policy round-robin <policy name> default quantum <packets>`

* Define a maximum queue lenght for the default policy in packets:
  :code:`set traffic-policy round-robin <policy name> default queue-limit <limit>`

* Specify the queuing type for the default policy, available queue types:

 * drop-tail
 * fair-queue
 * priority (based on the DSCP values in the ToS byte)

  :code:`set traffic-policy round-robin <policy name> default queue-type <type>`

Matching rules
**************

* Define a class matching rule:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name>`

* Add a match rule description:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> description <description>`

* Specify a match criterion based on a **destination MAC address** (format:
  xx:xx:xx:xx:xx:xx):
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ether destination <MAC address>`

* Specify a match criterion based on a **source MAC address** (format:
  xx:xx:xx:xx:xx:xx):
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ether source <MAC address>`

* Specify a match criterion based on **packet type/protocol**, range 0...65535:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ether protocol <number>`

* Specify a match criterion based on **ingress interface**:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> interface <interface>`

* Specify a match criterion based on the **fwmark field**, range 0....4294967295:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> mark <fwmark>`

* Specify a match criterion based on **VLAN ID**, range 1...4096:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> vif <VLAN ID>*`

**IPv4**

* Specify a match criterion based on **destination IPv4 address and/or port**,
  port may be specified as number or service name (i.e. ssh):
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ip destination <IPv4 address|port>`

* Specify a match criterion based on **source IPv4 address and/or port**, port
  may be specified as number or service name (i.e. ssh):
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ip source <IPv4 address|port>`

* Specify a match criterion based on **DSCP (Differentiated Services Code Point)
  value**, DSCP value may be specified as decimal or hexadecimal number:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ip dscp <DSCP value>`

* Specify a match criterion based on **IPv4 protocol**, protocol may be
  specified by name (i.e. icmp) or IANA-assigned number:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ip protocol <proto>`

**IPv6**

* Specify a match criterion based on **destination IPv6 address and/or port**,
  port may be specified as number or service name (i.e. ssh):
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ipv6 destination <IPv6 address|port>`

* Specify a match criterion based on **source IPv6 address and/or port**, port
  may be specified as number or service name (i.e. ssh):
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ipv6 source <IPv6 address|port>`

* Specify a match criterion based on **DSCP (Differentiated Services Code Point)
  value**, DSCP value may be specified as decimal or hexadecimal number:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ipv6 dscp <DSCP value>`

* Specify a match criterion based on **IPv6 protocol**, protocol may be
  specified by name (i.e. icmp) or IANA-assigned number:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> ipv6 protocol <proto>`

Traffic shaper
--------------

The shaper policy uses the Hierarchical Token Bucket algorithm to allocate
different amounts of bandwidth to different traffic classes. In contrast to
round robin, shaper limits bandwidth allocation by traffic class whereas round
robin divides the total available bandwidth between classes.

Avialable commands:

* Define a shaper policy:
  :code:`set traffic-policy shaper <policy-name>`

* Add a description:
  :code:`set traffic-policy shaper <policy-name> description <description>`

* Set the available bandwidth for all combined traffic of this policy in kbit/s,
  default 100%:
  :code:`set traffic-policy shaper <policy-name> bandwidth <rate>`
  Available suffixes:

 * %    (percentage of total bandwidth)
 * kbit (kilobits per second)
 * mbit (megabits per second)
 * gbit (gigabits per second)
 * kbps (kilobytes per second)
 * mbps (megabytes per second)
 * gbps (gigabytes per second)

Traffic classes
^^^^^^^^^^^^^^^

* Define a traffic class for a shaper policy, range for class ID is 2...4095:
  :code:`set traffic-policy shaper <policy-name> class <class ID>`

* Add a class description:
  :code:`set traffic-policy shaper <policy name> class <class ID> description
  <description>`

* Specify a bandwidth limit for a class, in kbit/s:
  :code:`set traffic-policy shaper <policy-name> class <class ID> bandwidth <rate>`
  Available suffixes:

 * kbit (kilobits per second, default)
 * mbit (megabits per second)
 * gbit (gigabits per second)
 * kbps (kilobytes per second)
 * mbps (megabytes per second)
 * gbps (gigabytes per second)

* Set a burst size for a class, the maximum amount of traffic that can be sent,
  in bytes: :code:`set traffic-policy shaper <policy-name> class <class ID>
  burst <burst-size>` Available suffixes:

 * kb (kilobytes)
 * mb (megabytes)
 * gb (gigabytes)

* Set a bandwidth ceiling for a class in kbit/s:
  :code:`set traffic-policy shaper <policy-name> class <class ID> ceiling <rate>`
  Available suffixes:

 * %    (percentage of total bandwidth)
 * kbit (kilobits per second)
 * mbit (megabits per second)
 * gbit (gigabits per second)

* Set the priority of a class for allocation of additional bandwidth, if unused
  bandwidth is available. Range 0...7, lowest number has lowest priority,
  default 0: :code:`set traffic-policy shaper <policy-name> class <class ID>
  priority <priority>`

* Set a queue length limit in packets:
  :code:`set traffic-policy shaper <policy name> class <class ID> queue-limit
  <limit>`

* Specify a queue type for a traffic class, default fair-queue. Available
  queue types:

 * drop-tail
 * fair-queue
 * random-detect
 * priority

  :code:`set traffic-policy shaper <policy name> class <class ID> queue-type <type>`

* Modify DSCP field; the DSCP field value of packets in a class can be
  rewritten to change the forwarding behaviour and allow for traffic
  conditioning: :code:`set traffic-policy shaper <policy name> class <class ID>
  set-dscp <value>`

  DSCP values as per RFC2474_ and RFC4595_:

  +---------+------------+--------+------------------------------+
  | Binary  | Configured |  Drop  | Description                  |
  | value   | value      |  rate  |                              |
  +=========+============+========+==============================+
  | 101110  |     46     |   -    | Expedited forwarding (EF)    |
  +---------+------------+--------+------------------------------+
  | 000000  |     0      |   -    | Best effort traffic, default |
  +---------+------------+--------+------------------------------+
  | 001010  |     10     | Low    | Assured Forwarding(AF) 11    |
  +---------+------------+--------+------------------------------+
  | 001100  |     12     | Medium | Assured Forwarding(AF) 12    |
  +---------+------------+--------+------------------------------+
  | 001110  |     14     | High   | Assured Forwarding(AF) 13    |
  +---------+------------+--------+------------------------------+
  | 010010  |     18     | Low    | Assured Forwarding(AF) 21    |
  +---------+------------+--------+------------------------------+
  | 010100  |     20     | Medium | Assured Forwarding(AF) 22    |
  +---------+------------+--------+------------------------------+
  | 010110  |     22     | High   | Assured Forwarding(AF) 23    |
  +---------+------------+--------+------------------------------+
  | 011010  |     26     | Low    | Assured Forwarding(AF) 31    |
  +---------+------------+--------+------------------------------+
  | 011100  |     28     | Medium | Assured Forwarding(AF) 32    |
  +---------+------------+--------+------------------------------+
  | 011110  |     30     | High   | Assured Forwarding(AF) 33    |
  +---------+------------+--------+------------------------------+
  | 100010  |     34     | Low    | Assured Forwarding(AF) 41    |
  +---------+------------+--------+------------------------------+
  | 100100  |     36     | Medium | Assured Forwarding(AF) 42    |
  +---------+------------+--------+------------------------------+
  | 100110  |     38     | High   | Assured Forwarding(AF) 43    |
  +---------+------------+--------+------------------------------+

Matching rules
^^^^^^^^^^^^^^

* Define a class matching rule:
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name>`

* Add a match rule description:
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> description <description>`

* Specify a match criterion based on a **destination MAC address**
  (format: xx:xx:xx:xx:xx:xx):
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ether destination <MAC address>`

* Specify a match criterion based on a **source MAC address**
  (format: xx:xx:xx:xx:xx:xx):
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ether source <MAC address>`

* Specify a match criterion based on **packet type/protocol**, range 0...65535:
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ether protocol <number>`

* Specify a match criterion based on **ingress interface**:
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> interface <interface>`

* Specify a match criterion based on the **fwmark field**, range 0....4294967295:
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> mark <fwmark>`

* Specify a match criterion based on **VLAN ID**, range 1...4096:
  :code:`set traffic-policy round-robin <policy name> class <class ID> match
  <match name> vif <VLAN ID>`

**IPv4**

* Specify a match criterion based on **destination IPv4 address and/or port**,
  port may be specified as number or service name (i.e. ssh):
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ip destination <IPv4 address|port>`

* Specify a match criterion based on **source IPv4 address and/or port**, port
  may be specified as number or service name (i.e. ssh):
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ip source <IPv4 address|port>`

* Specify a match criterion based on **DSCP (Differentiated Services Code Point)
  value**, DSCP value may be specified as decimal or hexadecimal number:
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ip dscp <DSCP value>`

* Specify a match criterion based on **IPv4 protocol**, protocol may be
  specified by name (i.e. icmp) or IANA-assigned number:
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ip protocol <proto>`

**IPv6**

* Specify a match criterion based on **destination IPv6 address and/or port**,
  port may be specified as number or service name (i.e. ssh):
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ipv6 destination <IPv6 address|port>`

* Specify a match criterion based on **source IPv6 address and/or port**,
  port may be specified as number or service name (i.e. ssh):
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ipv6 source <IPv6 address|port>`

* Specify a match criterion based on **DSCP (Differentiated Services Code Point)
  value**, DSCP value may be specified as decimal or hexadecimal number:
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ipv6 dscp <DSCP value>`

* Specify a match criterion based on **IPv6 protocol**, protocol may be
  specified by name (i.e. icmp) or IANA-assigned number:
  :code:`set traffic-policy shaper <policy name> class <class ID> match
  <match name> ipv6 protocol <proto>`

shaper-hfsc (HFSC_ + sfq)
-------------------------

The case of ingress shaping. Only a **limiter** policy can be applied directly
for ingress traffic on an interface. It is possible though to use what is
called an Intermediate Functional Block (IFB_) to allow the usage of any policy
on the ingress traffic.

Let's assume eth0 is your WAN link. You created two traffic-policies: `WAN-IN`
and `WAN-OUT`.

First, create the IFB:

.. code-block:: sh

  set interfaces input ifb0 description "WAN Input"

Apply the `WAN-OUT` traffic-policy to ifb0 input.

.. code-block:: sh

  set interfaces input ifb0 traffic-policy in WAN-IN

Redirect traffic from eth0 to ifb0

.. code-block:: sh

  set interfaces ethernet eth0 redirect ifb0

Classful policies and traffic matching
--------------------------------------

`limiter`, `round-robin`, `priority-queue`, `shaper` and `shaper-hfsc`
distribute traffic into different classes with different options. In VyOS,
classes are numbered and work like firewall rules. e.g:

.. code-block:: sh

  set traffic-policy shaper SHAPER class 30

Matching traffic
^^^^^^^^^^^^^^^^

A class can have multiple match filters:

.. code-block:: sh

  set traffic-policy <POLICY> <POLICY-NAME> class N match MATCH-FILTER-NAME

Example:

.. code-block:: sh

  set traffic-policy shaper SHAPER class 30 match HTTP
  set traffic-policy shaper SHAPER class 30 match HTTPs

A match filter contains multiple criteria and will match traffic if all those criteria are true.

For example:

.. code-block:: sh

  set traffic-policy shaper SHAPER class 30 match HTTP ip protocol tcp
  set traffic-policy shaper SHAPER class 30 match HTTP ip source port 80

This will match tcp traffic with source port 80.

description
***********

.. code-block:: sh

  set traffic-policy shaper SHAPER class 30 match MATCH description "match filter description"

ether
*****

.. code-block:: sh

  edit traffic-policy shaper SHAPER class 30 match MATCH ether

destination
***********

protocol
********

source
******

interface
*********

.. code-block:: sh

  edit traffic-policy shaper SHAPER class 30 match MATCH interface <interface-name>

ip
**
.. code-block:: sh

  edit traffic-policy shaper SHAPER class 30 match MATCH ip

destination
***********

.. code-block:: sh

 set destination address IPv4-SUBNET
 set destination port U32-PORT

dscp
****

.. code-block:: sh

  set dscp DSCPVALUE

max-length
**********

.. code-block:: sh

  set max-length U32-MAXLEN

Will match ipv4 packets with a total length lesser than set value.

protocol
********
.. code-block:: sh

  set protocol <IP PROTOCOL>

source
******

.. code-block:: sh

  set source address IPv4-SUBNET
  set source port U32-PORT

tcp
***

**NOTE:** you must set ip protocol to TCP to use the TCP filters.
**NOTE#2**: This filter will only match packets with an IPv4 header length of
20 bytes (which is the majority of IPv4 packets anyway).

.. code-block:: sh

 set tcp ack

Will match tcp packets with ACK flag set.
.. code-block:: sh

  set tcp syn

Will match tcp packets with SYN flag set.

ipv6
****

.. code-block:: sh

  edit traffic-policy shaper SHAPER class 30 match MATCH ipv6

destination
***********

 .. code-block:: sh

  set destination address IPv6-SUBNET
  set destination port U32-PORT

dscp
****

.. code-block:: sh

  set dscp DSCPVALUE

max-length
**********

.. code-block:: sh

  set max-length U32-MAXLEN

Will match ipv6 packets with a payload length lesser than set value.

protocol
********

.. code-block:: sh

  set protocol IPPROTOCOL

source
******

.. code-block:: sh

  set source address IPv6-SUBNET
  set source port U32-PORT

tcp
***

**NOTE**: you must set ipv6 protocol to TCP to use the TCP filters.
**NOTE#2**: This filter will only match IPv6 packets with no header extension
(http://en.wikipedia.org/wiki/IPv6_packet#Extension_headers no header extension).

.. code-block:: sh

  set tcp ack

Will match tcp packets with ACK flag set.

.. code-block:: sh

  set tcp syn

Will match tcp packets with SYN flag set.

mark
****

.. code-block:: sh

  set traffic-policy shaper SHAPER class 30 match MATCH mark **firewall-mark**

vif
***

.. code-block:: sh

  set traffic-policy shaper SHAPER class 30 match MATCH vif **vlan-tag**



Examples:
---------

One common use of traffic policy is to limit bandwidth for an interface. In
the example below we limit bandwidth for our LAN connection to 200 Mbit
download and out WAN connection to 50 Mbit upload:

.. code-block:: sh

  set traffic-policy shaper WAN-OUT bandwidth '50Mbit'
  set traffic-policy shaper WAN-OUT default bandwidth '50%'
  set traffic-policy shaper WAN-OUT default ceiling '100%'
  set traffic-policy shaper WAN-OUT default queue-type 'fair-queue'

  set traffic-policy shaper LAN-OUT bandwidth '200Mbit'
  set traffic-policy shaper LAN-OUT default bandwidth '50%'
  set traffic-policy shaper LAN-OUT default ceiling '100%'
  set traffic-policy shaper LAN-OUT default queue-type 'fair-queue'

Resulting in the following configuration:

.. code-block:: sh

  traffic-policy {
      shaper WAN-OUT {
          bandwidth 50Mbit
          default {
              bandwidth 50%
              ceiling 100%
              queue-type fair-queue
          }
      }
      shaper LAN-OUT {
          bandwidth 200Mbit
          default {
              bandwidth 50%
              ceiling 100%
              queue-type fair-queue
          }
      }
  }

Once defined, a traffic policy can be applied to each interface using the
interface-level `traffic-policy` directive:

.. code-block:: sh

  set interfaces ethernet eth0 traffic-policy out 'WAN-OUT'
  set interfaces ethernet eth1 traffic-policy out 'LAN-OUT'

Note that a traffic policy can also be defined to match specific traffic flows
using class statements.

.. _tc: http://en.wikipedia.org/wiki/Tc_(Linux)
.. _RFC791: https://tools.ietf.org/html/rfc791
.. _TBF: https://en.wikipedia.org/wiki/Token_bucket
.. _RFC2474: https://tools.ietf.org/html/rfc2474#page-7
.. _RFC4595: https://tools.ietf.org/html/rfc4594#page-19
.. _HFSC: https://en.wikipedia.org/wiki/Hierarchical_fair-service_curve
.. _IFB: http://www.linuxfoundation.org/collaborate/workgroups/networking/ifb