Difference between revisions of "Manual:Queue"

From MikroTik Wiki
Jump to: navigation, search
m
Line 27: Line 27:
 
===Flow Identifiers===
 
===Flow Identifiers===
  
* '''name''' (Text) :  
+
* '''name''' (Text) : Unique queue identifier that can be used as '''parent''' option value for other queues
* '''target-addresses''' (comma separated list of IP prefixes) :
+
* '''target-addresses''' (multiple choice: IP address/netmask) : list/range of IP addresses that will be limited by this queue. This is one of two possible options that allow queue to determine what direction is target upload and what direction is target download.
* '''dst-address''' (IP prefix) :  
+
* '''interface''' (Name of interface, or ''all'') : identifies interface the target is connected to. useful in case when it is impossible to determine targets address. This is second of two possible options that allow queue to determine what direction is target upload and what direction is target download.
* '''interface''' (Name of interface, or ''all'') :  
+
 
* '''direction''' (One of ''both'', ''upload'', ''download'' or ''none'') :  
+
IF both '''target-addresses'''and '''interface''' is not specified queue will be unable to make difference between upload from download and will limit all traffic twice.
* '''time''' () :  
+
 
 +
* '''direction''' (One of ''both'', ''upload'', ''download'') : allow to enable one-directional limitation for simple queues (disable other direction).
 +
 
 +
* '''time''' (time-time, sat | fri | thu | wed | tue | mon | sun{+}; default: "") : allow to specify time when particular queue will be active. Router must have correct time settings.
 +
 
 +
* '''dst-address''' (IP address/netmask) : allow to specify seco
 +
 
 +
 +
 
 
* '''p2p''' () :  
 
* '''p2p''' () :  
 
* '''packet-marks''' (Comma separated list of) :  
 
* '''packet-marks''' (Comma separated list of) :  
Line 39: Line 47:
  
 
* '''parent''' (Name of , or ''none'') :  
 
* '''parent''' (Name of , or ''none'') :  
* '''priority''' (1..8) :  
+
* '''priority''' (1..8) : Prioritize one child queue over other child queue. Does not work on parent queues (if queue has at least one child). One is the highest, eight is the lowest priority. Child queue with higher priority will have chance to reach its '''limit-at''' before child with lower priority and after that child queue with higher priority will have chance to reach its '''max-limit''' before child with lower priority. Priority have nothing to do with bursts.
 
 
 
* '''queue''' (''SOMETHING/SOMETHING'') :  
 
* '''queue''' (''SOMETHING/SOMETHING'') :  
 
* '''limit-at''' (''NUMBER/NUMBER'') :  
 
* '''limit-at''' (''NUMBER/NUMBER'') :  
Line 50: Line 57:
 
And corresponding options for global-total HTB queue:
 
And corresponding options for global-total HTB queue:
  
* '''total-queue''' ():  corresponds to ''queue'' only for global-total queue  
+
* '''total-queue''' (''SOMETHING/SOMETHING''):  corresponds to ''queue'' only for global-total queue  
* '''total-limit-at''' ():  corresponds to ''limit-at'' only for global-total queue   
+
* '''total-limit-at''' (''NUMBER/NUMBER''):  corresponds to ''limit-at'' only for global-total queue   
* '''total-max-limit''' ():  corresponds to ''max-limit'' only for global-total queue  
+
* '''total-max-limit''' (''NUMBER/NUMBER''):  corresponds to ''max-limit'' only for global-total queue  
* '''total-burst-limit''' ():  corresponds to ''burst-limit'' only for global-total queue  
+
* '''total-burst-limit''' (''NUMBER/NUMBER''):  corresponds to ''burst-limit'' only for global-total queue  
* '''total-burst-threshold''' ():  corresponds to ''burst-threshold'' only for global-total queue  
+
* '''total-burst-threshold''' (''NUMBER/NUMBER''):  corresponds to ''burst-threshold'' only for global-total queue  
* '''total-burst-time''' ():  corresponds to ''burst-time'' only for global-total queue  
+
* '''total-burst-time''' (''TIME/TIME''):  corresponds to ''burst-time'' only for global-total queue  
  
 
===Statistics===
 
===Statistics===

Revision as of 12:43, 26 September 2008

Queues

Submenu level: /queue

Queue implementation in MikroTik RouterOS is based on Hierarchical Token Bucket (HTB). HTB allows to create hierarchical queue structure and determine relations between queues(parent-child, child priority).

In RouterOS it is possible to add queue in 4 different places (HTBs):

  • global-in: represents all the input interfaces in general (INGRESS queue). Queues attached to global-in apply to traffic that is received by the router before the packet filtering
  • global-out: represents all the output interfaces in general (EGRESS queue).
  • global-total: represents all input and output interfaces together (in other words it is aggregation of global-in and global-out). Used in case when costumers have single limit for both, upload and download.
  • <interface name>: - represents one particular outgoing interface. Only traffic that is designated to go out via this interface will pass this HTB queue

There are two ways how to add queues in RouterOS:

  • /queue simple menu - more user-friendly implementation of queues designed to ease configuration of simple,everyday queuing tasks (such as single client upload/download limitation, p2p traffic limitation, etc.).
  • /queue tree menu - simplest way to implement advanced queuing tasks (such as global prioritization policy, user group limitations) require market packet flows from /ip firewall mangle facility.

Simple Queues

Submenu level: /queue simple

Simple queues represents three queues in one. Single simple queue will create one queue in global-in, one queue in global-out and one queue in global-total.

If no settings are specified in upload/download/total part of the queue corresponding queue it will not be created. This way creation of global-total queues can be avoided if separate upload/download limitation is used. This also means that you must change at least one setting in the simple queue to get simple queue working.

Flow Identifiers

  • name (Text) : Unique queue identifier that can be used as parent option value for other queues
  • target-addresses (multiple choice: IP address/netmask) : list/range of IP addresses that will be limited by this queue. This is one of two possible options that allow queue to determine what direction is target upload and what direction is target download.
  • interface (Name of interface, or all) : identifies interface the target is connected to. useful in case when it is impossible to determine targets address. This is second of two possible options that allow queue to determine what direction is target upload and what direction is target download.

IF both target-addressesand interface is not specified queue will be unable to make difference between upload from download and will limit all traffic twice.

  • direction (One of both, upload, download) : allow to enable one-directional limitation for simple queues (disable other direction).
  • time (time-time, sat | fri | thu | wed | tue | mon | sun{+}; default: "") : allow to specify time when particular queue will be active. Router must have correct time settings.
  • dst-address (IP address/netmask) : allow to specify seco


  • p2p () :
  • packet-marks (Comma separated list of) :

HTB Properties

  • parent (Name of , or none) :
  • priority (1..8) : Prioritize one child queue over other child queue. Does not work on parent queues (if queue has at least one child). One is the highest, eight is the lowest priority. Child queue with higher priority will have chance to reach its limit-at before child with lower priority and after that child queue with higher priority will have chance to reach its max-limit before child with lower priority. Priority have nothing to do with bursts.
  • queue (SOMETHING/SOMETHING) :
  • limit-at (NUMBER/NUMBER) :
  • max-limit (NUMBER/NUMBER) :
  • burst-limit (NUMBER/NUMBER) :
  • burst-threshold (NUMBER/NUMBER) :
  • burst-time (TIME/TIME) :

And corresponding options for global-total HTB queue:

  • total-queue (SOMETHING/SOMETHING): corresponds to queue only for global-total queue
  • total-limit-at (NUMBER/NUMBER): corresponds to limit-at only for global-total queue
  • total-max-limit (NUMBER/NUMBER): corresponds to max-limit only for global-total queue
  • total-burst-limit (NUMBER/NUMBER): corresponds to burst-limit only for global-total queue
  • total-burst-threshold (NUMBER/NUMBER): corresponds to burst-threshold only for global-total queue
  • total-burst-time (TIME/TIME): corresponds to burst-time only for global-total queue

Statistics

  • bytes (NUMBER/NUMBER; read-only) :
  • packets (read-only) :
  • dropped (read-only) :
  • overlimits (read-only) :
  • rate (read-only) :
  • packet-rate (read-only) :
  • queued-packets (read-only) :
  • queued-bytes (read-only) :
  • lends (read-only) :
  • borrows (read-only) :
  • pcq-queues () :

And corresponding options for global-total HTB queue:

  • total-bytes (read-only): corresponds to bytes only for global-total queue
  • total-packets (read-only): corresponds to packets only for global-total queue
  • total-dropped (read-only): corresponds to dropped only for global-total queue
  • total-overlimits (read-only): corresponds to overlimits only for global-total queue
  • total-rate (read-only): corresponds to rate only for global-total queue
  • total-packet-rate (read-only): corresponds to packet-rate only for global-total queue
  • total-queued-packets (read-only): corresponds to queued-packets only for global-total queue
  • total-queued-bytes (read-only): corresponds to queued-bytes only for global-total queue
  • total-lends (read-only): corresponds to lends only for global-total queue
  • total-borrows (read-only): corresponds to borrows only for global-total queue
  • total-pcq-queues (read-only): corresponds to pcq-queues only for global-total queue