MikroTik API icon

MikroTik API

Community Node for MikroTik RouterOS API

Actions67

Queue Simple → Get All

AI-generated

Summary

Retrieves all simple queue entries from the MikroTik device.

Inputs

  • options — Optional configuration affecting connectivity and output formatting.
  • connectionAttempts — Number of times to try connecting; default 5.
  • connectionDelay — Delay between connection attempts in seconds; default 3.
  • cleanKeys — When enabled, replaces '-' and '/' with '_' in response data keys.
  • tag — Custom tag appended to the command as '.tag=N' when set to a value > 0.

Output shape

Each returned item contains { resource, operation, count, data } where data is the array of queue simple entries from the RouterOS /queue/simple/print command. If cleanKeys is true, hyphens and slashes in data keys are replaced with underscores.

The tag parameter, when > 0, adds '.tag=N' to the sent parameters. Connection retries and delay are governed by connectionAttempts and connectionDelay.

Examples

Example 1: Basic get all with default options

Leave all optional parameters at defaults; the node connects, prints all simple queues, and returns the raw data.

Example 2: Get all with key cleaning and tagging

Set cleanKeys to true and tag to 42; the node cleans response keys and appends '.tag=42' to the command parameters.

Links

Discussion