Queues / QoS

ToolsCopy Anchor Link

• Create Queue Type (Qdisc)
• List Queue Types (Qdiscs)
• Get Queue Type Detail
• Update Queue Type Settings
• Remove Queue Type
• Create Queue Tree Entry
• List Queue Tree Entries
• Get Queue Tree Entry Detail
• Update Queue Tree Entry
• Remove Queue Tree Entry
• Enable Queue Tree Entry
• Disable Queue Tree Entry
• Create Simple Queue
• List Simple Queues
• Get Simple Queue Detail
• Update Simple Queue
• Remove Simple Queue
• Enable Simple Queue
• Disable Simple Queue

create_queue_typeCopy Anchor Link

Create Queue Type (Qdisc) · Risk: write

Creates a named queue discipline (/queue type) — the algorithm (cake, fq-codel, sfq, red, pcq, pfifo, bfifo, pfifo-bpf, mq-pfifo, none) that controls how packets within a queue are scheduled and dropped. Queue types are referenced by name in create_queue_tree and create_simple_queue via their queue parameter. kind selects the discipline; remaining params are per-discipline options (e.g. cake_flowmode, cake_nat, pcq_rate, pcq_classifier, fq_codel_target). For hierarchical bandwidth shaping use create_queue_tree; for flat per-target rate limiting use create_simple_queue. Returns details of the created queue type.

list_queue_typesCopy Anchor Link

List Queue Types (Qdiscs) · Risk: read

Lists all queue disciplines (/queue type print) configured on the device. Use name_filter (substring match) or kind_filter (exact kind) to narrow results. Returns all built-in and custom queue type entries. Use get_queue_type for full detail on a single entry. To list scheduling hierarchies use list_queue_trees; to list per-target rate limits use list_simple_queues.

get_queue_typeCopy Anchor Link

Get Queue Type Detail · Risk: read

Retrieves full detail for a single queue discipline (/queue type print detail where name=...). Resolves the name referenced in create_queue_tree or create_simple_queue via the queue field. Returns all parameters of that type, or a not-found message. Use list_queue_types to discover available names.

update_queue_typeCopy Anchor Link

Update Queue Type Settings · Risk: write-idempotent

Modifies an existing queue discipline (/queue type set [find name=...]). Supports renaming (new_name) and changing CAKE- or PCQ-specific parameters (cake_flowmode, cake_nat, cake_overhead, pcq_rate, pcq_classifier, etc.). Does not change the queue kind — to switch algorithm, remove and recreate the type with remove_queue_type then create_queue_type. Returns updated detail; if no parameters are provided returns 'No updates specified.' Use get_queue_type to confirm current values first.

remove_queue_typeCopy Anchor Link

Remove Queue Type · Risk: destructive

Permanently deletes a named queue discipline (/queue type remove [find name=...]). Will fail if the type is still referenced by an active queue tree or simple queue — remove those references first. Built-in types (e.g. 'default', 'default-small') cannot be removed. Returns a success or error message.

create_queue_treeCopy Anchor Link

Create Queue Tree Entry · Risk: write

Creates a hierarchical bandwidth-shaping node (/queue tree add) attached to a parent interface or another queue tree entry — the HTB-style tree for multi-level QoS. Use this when you need nested queues with shared bandwidth pools and packet-mark-based classification (marks produced by mangle tools). max_limit caps peak throughput (e.g. '10M', '512k', '1G'); limit_at guarantees minimum bandwidth; priority sets preemption order (1 highest, 8 lowest); queue names the qdisc from create_queue_type. For flat per-IP/CIDR rate limiting without a hierarchy use create_simple_queue instead. Returns the created entry's detail.

list_queue_treesCopy Anchor Link

List Queue Tree Entries · Risk: read

Lists all hierarchical queue tree nodes (/queue tree print) on the device. Supports filtering by name_filter (substring match), parent_filter (exact interface or parent queue name), disabled_only, and invalid_only. Returns the shaping hierarchy; use get_queue_tree for full detail on one node. For flat per-target rate-limiting queues use list_simple_queues.

get_queue_treeCopy Anchor Link

Get Queue Tree Entry Detail · Risk: read

Retrieves full detail for a single queue tree node (/queue tree print detail where name=...). Returns all attributes including bandwidth limits, parent, packet-mark, priority, qdisc reference, and enabled state, or a not-found message. Use list_queue_trees to discover names and update_queue_tree to modify. For simple per-target queues use get_simple_queue.

update_queue_treeCopy Anchor Link

Update Queue Tree Entry · Risk: write-idempotent

Modifies an existing queue tree node (/queue tree set [find name=...]). Accepts new_name, parent, queue (qdisc reference from create_queue_type), packet_mark, bandwidth params (max_limit, limit_at, burst_limit, burst_threshold as RouterOS rate strings e.g. '10M', '512k', '1G'; burst_time e.g. '8s'), priority (1 highest – 8 lowest), comment, and disabled. Returns updated detail; if no parameters are specified returns 'No updates specified.' Use get_queue_tree to confirm current state before updating. For simple per-target queues use update_simple_queue.

remove_queue_treeCopy Anchor Link

Remove Queue Tree Entry · Risk: destructive

Permanently deletes a queue tree node (/queue tree remove [find name=...]). Child nodes that reference this entry as their parent will become invalid — remove or reparent them first. Returns a success or error message. Use list_queue_trees to identify the name. For simple per-target queues use remove_simple_queue.

enable_queue_treeCopy Anchor Link

Enable Queue Tree Entry · Risk: write-idempotent

Re-activates a disabled queue tree node (/queue tree set [find name=...] disabled=no). Restores the node's bandwidth-shaping rules in the hierarchy without modifying any other parameters. Returns the updated detail. To deactivate use disable_queue_tree. For simple per-target queues use enable_simple_queue.

disable_queue_treeCopy Anchor Link

Disable Queue Tree Entry · Risk: write-idempotent

Deactivates a queue tree node without removing it (/queue tree set [find name=...] disabled=yes). Suspends that node's bandwidth constraints while preserving its configuration; re-activate with enable_queue_tree. Returns the updated detail. For simple per-target queues use disable_simple_queue.

create_simple_queueCopy Anchor Link

Create Simple Queue · Risk: write

Creates a flat per-target rate-limiting entry (/queue simple add) that shapes traffic for a specific IP address, CIDR subnet, or interface — the quickest way to cap upload/download bandwidth without building a queue tree hierarchy. target is the IP/CIDR or interface (e.g. '192.168.1.0/24', 'ether1'); max_limit caps bandwidth as 'UL/DL' or a single value (e.g. '10M/10M', '5M'); limit_at guarantees minimum bandwidth; burst_limit, burst_threshold, burst_time (e.g. '8s') allow short-term speed above max_limit; queue names the qdisc from create_queue_type. For packet-mark-based multi-level shaping use create_queue_tree instead. Returns the created entry's detail.

list_simple_queuesCopy Anchor Link

List Simple Queues · Risk: read

Lists all per-target rate-limiting entries (/queue simple print) on the device. Supports filtering by name_filter (substring match), target_filter (substring match on IP/interface), disabled_only, and invalid_only. Returns all matching simple queue entries. Use get_simple_queue for full detail on a single entry. For the hierarchical shaping tree use list_queue_trees.

get_simple_queueCopy Anchor Link

Get Simple Queue Detail · Risk: read

Retrieves full detail for a single simple queue entry (/queue simple print detail where name=...). Returns target, bandwidth limits, burst parameters, qdisc reference, and enabled state, or a not-found message. Use list_simple_queues to discover names. For hierarchical queue nodes use get_queue_tree.

update_simple_queueCopy Anchor Link

Update Simple Queue · Risk: write-idempotent

Modifies an existing per-target rate-limiting entry (/queue simple set [find name=...]). Accepts new_name, target (IP/CIDR or interface e.g. '192.168.1.0/24', 'ether1'), dst, bandwidth params (max_limit, limit_at, burst_limit, burst_threshold as 'UL/DL' or single value e.g. '10M/10M', '5M'; burst_time e.g. '8s'), queue (qdisc reference), parent, priority (1 highest – 8 lowest), packet_marks, comment, and disabled. Returns updated detail; if no parameters are provided returns 'No updates specified.' Use get_simple_queue to confirm current state first. For hierarchical queue nodes use update_queue_tree.

remove_simple_queueCopy Anchor Link

Remove Simple Queue · Risk: destructive

Permanently deletes a simple queue entry (/queue simple remove [find name=...]). Removes the per-target rate limit for that IP/CIDR or interface. Returns a success or error message. Use list_simple_queues to identify the name. For hierarchical queue nodes use remove_queue_tree.

enable_simple_queueCopy Anchor Link

Enable Simple Queue · Risk: write-idempotent

Re-activates a disabled simple queue entry (/queue simple set [find name=...] disabled=no). Restores the per-target bandwidth shaping without altering any other parameters. Returns the updated detail. To deactivate use disable_simple_queue. For hierarchical queue nodes use enable_queue_tree.

disable_simple_queueCopy Anchor Link

Disable Simple Queue · Risk: write-idempotent

Deactivates a simple queue entry without removing it (/queue simple set [find name=...] disabled=yes). Suspends the per-target rate limit while preserving its configuration; re-activate with enable_simple_queue. Returns the updated detail. For hierarchical queue nodes use disable_queue_tree.