Page tree

/queue

Bandwidth management

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

monitor

Monitor queue packets and bytes
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

file
Type: string
interesting: False
File name where to print output

intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

once
Type: switch
value: True
Execute and print commands output just once

without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

/queue/interface

Queue type setting for interface

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [queue]
Name of editable property
Enum parameters:
  • queue - Queue type which will be used for the interface

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [active-queue | default-queue | interface | queue]
Name of the value you want to get

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'active-queue', 'value': 3}, {'key': 'default-queue', 'value': 2}, {'key': 'interface', 'value': 0}, {'key': 'queue', 'value': 1}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Interface name'}, {'key': 1, 'value': 'Queue type which will be used for the interface'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

set

Change item properties
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

queue
Queue type which will be used for the interface

/queue/simple

Simple Bandwidth management

add

Create a new item
ParameterTypeDescriptionAdditional Notes
bucket-size
Type: super


burst-limit
Type: super
Maximal allowed burst of data rate in form of in/out

burst-threshold
Type: super
Average burst threshold in form of in/out

burst-time
Type: super
Burst time in form in/out

comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

copy-fromarg_node
ID of item to make a copy from

disabledbool
Defines whether item is ignored or used

dst
Type: alt
interface: enum_arg
ip-address: ip_prefix_arg
ipv6-address: ip6_prefix_arg


limit-at
Type: super
Guaranteed data rate to this queue

max-limit
Type: super
Data rate which can be reached if there is enough bandwidth available

name
Type: string
Queue name

packet-marks
Type: multi_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{20,13}'}]}}]}}, {'key': 'acc_name', 'value': {'producer': '"s0"', 'sub': []}}, {'key': 'loose', 'value': True}]}
maxlen: 128
switchIds: {4294967295}


parent
Name of the parent queue in the hierarchy

place-beforearg_node
Item number

priority
Type: super
Flow priority

queue
Type: super
Queue type

target
Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'target-address', 'value': {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip-address', 'value': {'producer': 'ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"be u1"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"be u2"', 'sub': []}}]}}, {'key': 'ipv6-address', 'value': {'producer': 'ip6_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"a3"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"u4"', 'sub': []}}]}}]}}]}}, {'key': 'target-interface', 'value': {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{20,0}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u5"', 'sub': []}}]}}]}}]}
maxlen: 128


time
Type: super
At which time and day of week to allow this queue

total-bucket-sizenum [0 .. 10000]

total-burst-limitnum [0 .. 4294967295]
Maximal allowed total (bidirectional) burst of data rate (bits/s)

total-burst-thresholdnum [0 .. 4294967295]
Total (bidirectional) average burst threshold (bits/s)

total-burst-timetime [-9223372036854775808 .. 9223372036854775807] unit: 1000000000
Total burst (bidirectional) time

total-limit-atnum [0 .. 4294967295]
Allocated total (bidirectional) stream data rate (bits/s)

total-max-limitnum [0 .. 4294967295]
Maximal total (bidirectional) stream data rate (bits/s)

total-prioritynum [1 .. 8]

total-queue
Queuing discipline to use for upload and download traffic

comment

Set comment for items
ParameterTypeDescriptionAdditional Notes
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

numbersarg_node
List of item numbers

disable

Disable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [bucket-size | burst-limit | burst-threshold | burst-time | comment | dst | limit-at | max-limit | name | packet-marks | parent | priority | queue | target | time | total-bucket-size | total-burst-limit | total-burst-threshold | total-burst-time | total-limit-at | total-max-limit | total-priority | total-queue]
Name of editable property

enable

Enable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [bucket-size | burst-limit | burst-threshold | burst-time | bytes | comment | disabled | dropped | dst | dynamic | invalid | limit-at | max-limit | name | packet-marks | packet-rate | packets | parent | pcq-queues | priority | queue | queued-bytes | queued-packets | rate | target | time | total-bucket-size | total-burst-limit | total-burst-threshold | total-burst-time | total-bytes | total-dropped | total-limit-at | total-max-limit | total-packet-rate | total-packets | total-pcq-queues | total-priority | total-queue | total-queued-bytes | total-queued-packets | total-rate]
Name of the value you want to get

move

Change order of items
ParameterTypeDescriptionAdditional Notes
destinationarg_node
Target to where the file should be moved

numbersarg_node
List of item numbers

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

bytes
Type: switch
value: True
Show subset of properties as a table

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

oid
Type: switch
value: True
print object IDs for SNMP protocol

packets
Type: switch
value: True
Show subset of properties as a table

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'bucket-size', 'value': 12}, {'key': 'burst-limit', 'value': 9}, {'key': 'burst-threshold', 'value': 10}, {'key': 'burst-time', 'value': 11}, {'key': 'bytes', 'value': 21}, {'key': 'comment', 'value': 50}, {'key': 'disabled', 'value': 49}, {'key': 'dropped', 'value': 26}, {'key': 'dst', 'value': 2}, {'key': 'dynamic', 'value': 48}, {'key': 'invalid', 'value': 47}, {'key': 'limit-at', 'value': 7}, {'key': 'max-limit', 'value': 8}, {'key': 'name', 'value': 0}, {'key': 'packet-marks', 'value': 4}, {'key': 'packet-rate', 'value': 30}, {'key': 'packets', 'value': 24}, {'key': 'parent', 'value': 3}, {'key': 'pcq-queues', 'value': 36}, {'key': 'priority', 'value': 5}, {'key': 'queue', 'value': 6}, {'key': 'queued-bytes', 'value': 34}, {'key': 'queued-packets', 'value': 32}, {'key': 'rate', 'value': 28}, {'key': 'target', 'value': 1}, {'key': 'time', 'value': 22}, {'key': 'total-bucket-size', 'value': 20}, {'key': 'total-burst-limit', 'value': 17}, {'key': 'total-burst-threshold', 'value': 18}, {'key': 'total-burst-time', 'value': 19}, {'key': 'total-bytes', 'value': 23}, {'key': 'total-dropped', 'value': 27}, {'key': 'total-limit-at', 'value': 15}, {'key': 'total-max-limit', 'value': 16}, {'key': 'total-packet-rate', 'value': 31}, {'key': 'total-packets', 'value': 25}, {'key': 'total-pcq-queues', 'value': 37}, {'key': 'total-priority', 'value': 13}, {'key': 'total-queue', 'value': 14}, {'key': 'total-queued-bytes', 'value': 35}, {'key': 'total-queued-packets', 'value': 33}, {'key': 'total-rate', 'value': 29}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Queue name'}, {'key': 3, 'value': 'Name of the parent queue in the hierarchy'}, {'key': 5, 'value': 'Flow priority'}, {'key': 6, 'value': 'Queue type'}, {'key': 7, 'value': 'Guaranteed data rate to this queue'}, {'key': 8, 'value': 'Data rate which can be reached if there is enough bandwidth available'}, {'key': 9, 'value': 'Maximal allowed burst of data rate in form of in/out'}, {'key': 10, 'value': 'Average burst threshold in form of in/out'}, {'key': 11, 'value': 'Burst time in form in/out'}, {'key': 14, 'value': 'Queuing discipline to use for upload and download traffic'}, {'key': 15, 'value': 'Allocated total (bidirectional) stream data rate (bits/s)'}, {'key': 16, 'value': 'Maximal total (bidirectional) stream data rate (bits/s)'}, {'key': 17, 'value': 'Maximal allowed total (bidirectional) burst of data rate (bits/s)'}, {'key': 18, 'value': 'Total (bidirectional) average burst threshold (bits/s)'}, {'key': 19, 'value': 'Total burst (bidirectional) time'}, {'key': 21, 'value': 'The count of bytes'}, {'key': 22, 'value': 'At which time and day of week to allow this queue'}, {'key': 23, 'value': 'Total count of bytes'}, {'key': 24, 'value': 'The count of packets'}, {'key': 25, 'value': 'Total count of packets'}, {'key': 26, 'value': 'Count of dropped packets'}, {'key': 27, 'value': 'Total count of dropped packets'}, {'key': 28, 'value': 'Data rate in bits/s'}, {'key': 29, 'value': 'Total data rate in bits/s'}, {'key': 30, 'value': 'Data rate in packets per second'}, {'key': 31, 'value': 'Total data rate in packets per second'}, {'key': 32, 'value': 'Number of enqueued packets'}, {'key': 33, 'value': 'Total number of enqueued packets'}, {'key': 34, 'value': 'Amount of data waiting in a queue'}, {'key': 35, 'value': 'Total amount of data waiting in a queue'}, {'key': 49, 'value': 'Defines whether item is ignored or used'}, {'key': 50, 'value': 'Short description of the item'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

rate
Type: switch
value: True
Data rate in bits/s

show-ids
Type: switch
value: True
Prints static IDs for selected submenu

stats
Type: switch
value: True
Show subset of properties in detailed form

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

reset-counters

Set bytes and packets counters to 0
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

reset-counters-all

Resets counters for all submenu objects

set

Change item properties
ParameterTypeDescriptionAdditional Notes
bucket-size
Type: super


burst-limit
Type: super
Maximal allowed burst of data rate in form of in/out

burst-threshold
Type: super
Average burst threshold in form of in/out

burst-time
Type: super
Burst time in form in/out

comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

disabledbool
Defines whether item is ignored or used

dst
Type: alt
interface: enum_arg
ip-address: ip_prefix_arg
ipv6-address: ip6_prefix_arg


limit-at
Type: super
Guaranteed data rate to this queue

max-limit
Type: super
Data rate which can be reached if there is enough bandwidth available

name
Type: string
Queue name

numbersarg_node
List of item numbers

packet-marks
Type: multi_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{20,13}'}]}}]}}, {'key': 'acc_name', 'value': {'producer': '"s0"', 'sub': []}}, {'key': 'loose', 'value': True}]}
maxlen: 128
switchIds: {4294967295}


parent
Name of the parent queue in the hierarchy

priority
Type: super
Flow priority

queue
Type: super
Queue type

target
Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'target-address', 'value': {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip-address', 'value': {'producer': 'ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"be u1"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"be u2"', 'sub': []}}]}}, {'key': 'ipv6-address', 'value': {'producer': 'ip6_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"a3"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"u4"', 'sub': []}}]}}]}}]}}, {'key': 'target-interface', 'value': {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{20,0}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u5"', 'sub': []}}]}}]}}]}
maxlen: 128


time
Type: super
At which time and day of week to allow this queue

total-bucket-sizenum [0 .. 10000]

total-burst-limitnum [0 .. 4294967295]
Maximal allowed total (bidirectional) burst of data rate (bits/s)

total-burst-thresholdnum [0 .. 4294967295]
Total (bidirectional) average burst threshold (bits/s)

total-burst-timetime [-9223372036854775808 .. 9223372036854775807] unit: 1000000000
Total burst (bidirectional) time

total-limit-atnum [0 .. 4294967295]
Allocated total (bidirectional) stream data rate (bits/s)

total-max-limitnum [0 .. 4294967295]
Maximal total (bidirectional) stream data rate (bits/s)

total-prioritynum [1 .. 8]

total-queue
Queuing discipline to use for upload and download traffic

unset

Unsets and removes user-set value to specified submenu object
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

value-name
enum [dst | target | time]
Name of property that can be unset

/queue/tree

Sophisticated Bandwidth management

add

Create a new item
ParameterTypeDescriptionAdditional Notes
bucket-sizenum [0 .. 10000]

burst-limitnum [0 .. 4294967295]
Maximal allowed burst of the data rate

burst-thresholdnum [0 .. 4294967295]
Average burst threshold

burst-timetime [-9223372036854775808 .. 9223372036854775807] unit: 1000000000
Burst time

comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

copy-fromarg_node
ID of item to make a copy from

disabledbool
Defines whether item is ignored or used

limit-atnum [0 .. 4294967295]
Maximum stream bit rate

max-limitnum [0 .. 4294967295]
Maximal limit

name
Type: string
Queue name

packet-mark
Type: multi_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{20,13}'}]}}]}}, {'key': 'acc_name', 'value': {'producer': '"s0"', 'sub': []}}, {'key': 'loose', 'value': True}]}
maxlen: 256
switchIds: {4294967295}


parent
Interface which queue uses

prioritynum [1 .. 8]
Flow priority

queue
Queue type

comment

Set comment for items
ParameterTypeDescriptionAdditional Notes
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

numbersarg_node
List of item numbers

disable

Disable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [bucket-size | burst-limit | burst-threshold | burst-time | comment | limit-at | max-limit | name | packet-mark | parent | priority | queue]
Name of editable property

enable

Enable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [bucket-size | burst-limit | burst-threshold | burst-time | bytes | comment | disabled | dropped | invalid | limit-at | max-limit | name | packet-mark | packet-rate | packets | parent | pcq-queues | priority | queue | queued-bytes | queued-packets | rate]
Name of the value you want to get

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

bytes
Type: switch
value: True
Show subset of properties as a table

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

oid
Type: switch
value: True
print object IDs for SNMP protocol

packets
Type: switch
value: True
Show subset of properties as a table

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'bucket-size', 'value': 10}, {'key': 'burst-limit', 'value': 7}, {'key': 'burst-threshold', 'value': 8}, {'key': 'burst-time', 'value': 9}, {'key': 'bytes', 'value': 11}, {'key': 'comment', 'value': 29}, {'key': 'disabled', 'value': 28}, {'key': 'dropped', 'value': 13}, {'key': 'invalid', 'value': 27}, {'key': 'limit-at', 'value': 3}, {'key': 'max-limit', 'value': 6}, {'key': 'name', 'value': 0}, {'key': 'packet-mark', 'value': 2}, {'key': 'packet-rate', 'value': 15}, {'key': 'packets', 'value': 12}, {'key': 'parent', 'value': 1}, {'key': 'pcq-queues', 'value': 18}, {'key': 'priority', 'value': 5}, {'key': 'queue', 'value': 4}, {'key': 'queued-bytes', 'value': 17}, {'key': 'queued-packets', 'value': 16}, {'key': 'rate', 'value': 14}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Queue name'}, {'key': 1, 'value': 'Interface which queue uses'}, {'key': 3, 'value': 'Maximum stream bit rate'}, {'key': 4, 'value': 'Queue type'}, {'key': 5, 'value': 'Flow priority'}, {'key': 6, 'value': 'Maximal limit'}, {'key': 7, 'value': 'Maximal allowed burst of the data rate'}, {'key': 8, 'value': 'Average burst threshold'}, {'key': 9, 'value': 'Burst time'}, {'key': 11, 'value': 'The count of bytes'}, {'key': 12, 'value': 'The count of packets'}, {'key': 13, 'value': 'Count of dropped packets'}, {'key': 14, 'value': 'Data rate in bits/s'}, {'key': 15, 'value': 'Data rate in packets per second'}, {'key': 16, 'value': 'Number of enqueued packets'}, {'key': 17, 'value': 'Amount of data waiting in a queue'}, {'key': 28, 'value': 'Defines whether item is ignored or used'}, {'key': 29, 'value': 'Short description of the item'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

rate
Type: switch
value: True
Data rate in bits/s

show-ids
Type: switch
value: True
Prints static IDs for selected submenu

stats
Type: switch
value: True
Show subset of properties in detailed form

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

reset-counters

Set bytes and packets counters to 0
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

reset-counters-all

Resets counters for all submenu objects

set

Change item properties
ParameterTypeDescriptionAdditional Notes
bucket-sizenum [0 .. 10000]

burst-limitnum [0 .. 4294967295]
Maximal allowed burst of the data rate

burst-thresholdnum [0 .. 4294967295]
Average burst threshold

burst-timetime [-9223372036854775808 .. 9223372036854775807] unit: 1000000000
Burst time

comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

disabledbool
Defines whether item is ignored or used

limit-atnum [0 .. 4294967295]
Maximum stream bit rate

max-limitnum [0 .. 4294967295]
Maximal limit

name
Type: string
Queue name

numbersarg_node
List of item numbers

packet-mark
Type: multi_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{20,13}'}]}}]}}, {'key': 'acc_name', 'value': {'producer': '"s0"', 'sub': []}}, {'key': 'loose', 'value': True}]}
maxlen: 256
switchIds: {4294967295}


parent
Interface which queue uses

prioritynum [1 .. 8]
Flow priority

queue
Queue type

/queue/type

Queue type

add

Create a new item
ParameterTypeDescriptionAdditional Notes
bfifo-limitnum [1000 .. 4294967295]
Maximum number of bytes that the BFIFO queue can hold

copy-fromarg_node
ID of item to make a copy from

kind
enum [bfifo | mq-pfifo | none | pcq | pfifo | red | sfq]
Queue type
Enum parameters:
  • bfifo - Bytes First-In First-Out

mq-pfifo-limitnum [1 .. 4294967295]

name
Type: string
Associative name of the queue type

pcq-burst-ratenum [0 .. 4294967295]

pcq-burst-thresholdnum [0 .. 4294967295]

pcq-burst-timetime [1000000000 .. 9223372036854775807] unit: 1000000000

pcq-classifier
Type: ubit_arg
+presence: {'producer': '', 'sub': [{'key': 'id', 'value': 'b15'}]}
bitspec: {'producer': '', 'sub': [{'key': 'dst-address', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 2}, {'key': 'ormask', 'value': 2}]}}, {'key': 'dst-port', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 8}, {'key': 'ormask', 'value': 8}]}}, {'key': 'src-address', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1}, {'key': 'ormask', 'value': 1}]}}, {'key': 'src-port', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 4}, {'key': 'ormask', 'value': 4}]}}]}
The classifier of grouping traffic flow

pcq-dst-address-masknum [0 .. 32]

pcq-dst-address6-masknum [0 .. 128]

pcq-limitnum [1 .. 4294967295]
PCQ queue limit
Maximal packet number that queue can hold

pcq-ratenum [0 .. 4294967295]
Maximal data rate assigned to one group (bits/s)

pcq-src-address-masknum [0 .. 32]

pcq-src-address6-masknum [0 .. 128]

pcq-total-limitnum [1 .. 4294967295]
Number of packets that can hold the whole PCQ queue

pfifo-limitnum [1 .. 4294967295]
Maximum number of packets that the PFIFO queue can hold

red-avg-packetnum [1 .. 65535]
Used by RED for average queue size calculations

red-burstnum [0 .. 4294967295]
Number of packets allowed for bursts of packets when there are no packets in the queue

red-limitnum [0 .. 4294967295]
RED queue limit in bytes
If the real queue size (not average) exceeds this value then all packets above this value are dropped

red-max-thresholdnum [0 .. 4294967295]
The average queue size at which packet marking probability is the highest

red-min-thresholdnum [0 .. 4294967295]
Average queue size in bytes
When average RED queue size reaches this value, packet marking becomes possible

sfq-allotnum [0 .. 32767]
How often to change hash function

sfq-perturbnum [0 .. 4294967295]
Amount of data in bytes that can be sent in one round-robin round

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [bfifo-limit | kind | mq-pfifo-limit | name | pcq-burst-rate | pcq-burst-threshold | pcq-burst-time | pcq-classifier | pcq-dst-address-mask | pcq-dst-address6-mask | pcq-limit | pcq-rate | pcq-src-address-mask | pcq-src-address6-mask | pcq-total-limit | pfifo-limit | red-avg-packet | red-burst | red-limit | red-max-threshold | red-min-threshold | sfq-allot | sfq-perturb]
Name of editable property
Enum parameters:
  • bfifo-limit - Maximum number of bytes that the BFIFO queue can hold

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [bfifo-limit | default | kind | mq-pfifo-limit | name | pcq-burst-rate | pcq-burst-threshold | pcq-burst-time | pcq-classifier | pcq-dst-address-mask | pcq-dst-address6-mask | pcq-limit | pcq-rate | pcq-src-address-mask | pcq-src-address6-mask | pcq-total-limit | pfifo-limit | red-avg-packet | red-burst | red-limit | red-max-threshold | red-min-threshold | sfq-allot | sfq-perturb]
Name of the value you want to get
Enum parameters:
  • bfifo-limit - Maximum number of bytes that the BFIFO queue can hold

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'bfifo-limit', 'value': 2}, {'key': 'default', 'value': 31}, {'key': 'kind', 'value': 1}, {'key': 'mq-pfifo-limit', 'value': 22}, {'key': 'name', 'value': 0}, {'key': 'pcq-burst-rate', 'value': 15}, {'key': 'pcq-burst-threshold', 'value': 16}, {'key': 'pcq-burst-time', 'value': 17}, {'key': 'pcq-classifier', 'value': 13}, {'key': 'pcq-dst-address-mask', 'value': 19}, {'key': 'pcq-dst-address6-mask', 'value': 21}, {'key': 'pcq-limit', 'value': 12}, {'key': 'pcq-rate', 'value': 11}, {'key': 'pcq-src-address-mask', 'value': 18}, {'key': 'pcq-src-address6-mask', 'value': 20}, {'key': 'pcq-total-limit', 'value': 14}, {'key': 'pfifo-limit', 'value': 3}, {'key': 'red-avg-packet', 'value': 8}, {'key': 'red-burst', 'value': 7}, {'key': 'red-limit', 'value': 4}, {'key': 'red-max-threshold', 'value': 6}, {'key': 'red-min-threshold', 'value': 5}, {'key': 'sfq-allot', 'value': 10}, {'key': 'sfq-perturb', 'value': 9}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Associative name of the queue type'}, {'key': 1, 'value': 'Queue type'}, {'key': 2, 'value': 'Maximum number of bytes that the BFIFO queue can hold'}, {'key': 3, 'value': 'Maximum number of packets that the PFIFO queue can hold'}, {'key': 4, 'value': 'RED queue limit in bytes'}, {'key': 5, 'value': 'Average queue size in bytes'}, {'key': 6, 'value': 'The average queue size at which packet marking probability is the highest'}, {'key': 7, 'value': 'Number of packets allowed for bursts of packets when there are no packets in the queue'}, {'key': 8, 'value': 'Used by RED for average queue size calculations'}, {'key': 9, 'value': 'Amount of data in bytes that can be sent in one round-robin round'}, {'key': 10, 'value': 'How often to change hash function'}, {'key': 11, 'value': 'Maximal data rate assigned to one group (bits/s)'}, {'key': 12, 'value': 'PCQ queue limit'}, {'key': 13, 'value': 'The classifier of grouping traffic flow'}, {'key': 14, 'value': 'Number of packets that can hold the whole PCQ queue'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

set

Change item properties
ParameterTypeDescriptionAdditional Notes
bfifo-limitnum [1000 .. 4294967295]
Maximum number of bytes that the BFIFO queue can hold

kind
enum [bfifo | mq-pfifo | none | pcq | pfifo | red | sfq]
Queue type
Enum parameters:
  • bfifo - Bytes First-In First-Out

mq-pfifo-limitnum [1 .. 4294967295]

name
Type: string
Associative name of the queue type

numbersarg_node
List of item numbers

pcq-burst-ratenum [0 .. 4294967295]

pcq-burst-thresholdnum [0 .. 4294967295]

pcq-burst-timetime [1000000000 .. 9223372036854775807] unit: 1000000000

pcq-classifier
Type: ubit_arg
+presence: {'producer': '', 'sub': [{'key': 'id', 'value': 'b15'}]}
bitspec: {'producer': '', 'sub': [{'key': 'dst-address', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 2}, {'key': 'ormask', 'value': 2}]}}, {'key': 'dst-port', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 8}, {'key': 'ormask', 'value': 8}]}}, {'key': 'src-address', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1}, {'key': 'ormask', 'value': 1}]}}, {'key': 'src-port', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 4}, {'key': 'ormask', 'value': 4}]}}]}
The classifier of grouping traffic flow

pcq-dst-address-masknum [0 .. 32]

pcq-dst-address6-masknum [0 .. 128]

pcq-limitnum [1 .. 4294967295]
PCQ queue limit
Maximal packet number that queue can hold

pcq-ratenum [0 .. 4294967295]
Maximal data rate assigned to one group (bits/s)

pcq-src-address-masknum [0 .. 32]

pcq-src-address6-masknum [0 .. 128]

pcq-total-limitnum [1 .. 4294967295]
Number of packets that can hold the whole PCQ queue

pfifo-limitnum [1 .. 4294967295]
Maximum number of packets that the PFIFO queue can hold

red-avg-packetnum [1 .. 65535]
Used by RED for average queue size calculations

red-burstnum [0 .. 4294967295]
Number of packets allowed for bursts of packets when there are no packets in the queue

red-limitnum [0 .. 4294967295]
RED queue limit in bytes
If the real queue size (not average) exceeds this value then all packets above this value are dropped

red-max-thresholdnum [0 .. 4294967295]
The average queue size at which packet marking probability is the highest

red-min-thresholdnum [0 .. 4294967295]
Average queue size in bytes
When average RED queue size reaches this value, packet marking becomes possible

sfq-allotnum [0 .. 32767]
How often to change hash function

sfq-perturbnum [0 .. 4294967295]
Amount of data in bytes that can be sent in one round-robin round

  • No labels