CLI Reference

The CLI reference documents RouterOS command menus and properties by console path. Use this section to look up command syntax, configuration objects, and operational commands for RouterOS features.

Argument types

• address — universal address parameter, rendered as address (flags=...); see address flags below
• alt — alternative type, can accept one of several different value types
• as — autonomous system number (used in BGP routing)
• bool — boolean value (true/false, yes/no)
• cfg — configuration entry identifier
• composite — combination of multiple arguments treated as a group
• date — date and time value
• enum — enumerator, has predefined values listed in parentheses
• expr — expression or condition (used in routing filters and scripting)
• file — file path or name reference
• iface_enum — interface selection list, can usually accept an interface name, or predefined values like all, none, dynamic, slave; values listed in braces
• ipAddr — IPv4 address
• ip6Addr — IPv6 address
• ipPrefix — IPv4 address with prefix length
• ip6Prefix — IPv6 address with prefix length
• ipRange — IPv4 address range
• macAddr — MAC address (can specify full address or with wildcards)
• meter — signal quality level, typically expressed in dBm
• multi — multi-value argument, accepts multiple values from a defined set
• num — unsigned integer, can be restricted with a range (e.g. [3 .. 20], [.. 10], [4 ..]); 32-bit range if not explicitly specified
• numericon — numeric value displayed with unit suffix
• object — structured list of values (e.g. a table of addresses or configuration items)
• pic — picture/bitmap value
• range — numeric range (e.g. a set of ports)
• remote — reference to a remote object (e.g. a routing filter rule)
• string — text string
• super — composite type accepting multiple different argument types; sub-types are listed in braces, e.g. super { bool, time }
• switch — on/off toggle without an explicit value argument
• time — time duration or interval, usually in seconds, may include units like s, m, h, d
• timezone — timezone or UTC offset value
• ubit — bitfield with named bits, supported bit names listed in parentheses, e.g. ubit (ip, ipv6)
• value — standalone value identifier (typically used as part of a composite or enum)
• varName — variable name reference (used in scripting)

Argument types can be nested, for example super {num, time, super {bool, ip}}.

The address type is rendered as address (flags=...) where the flags define which address formats are accepted:

Flag	Meaning
4	IPv4 address
6	IPv6 address
D	DNS name (hostname)
i	Interface name
/	Address with subnet mask (CIDR prefix)
v	VRF (Virtual Routing and Forwarding instance)
R	Route distinguisher
S	Free-form prefix (e.g. EVPN prefix)
+	Address list
:	Port or zone specifier
L	Link-local address

Grafts and Captures

If parameters are grouped in captures, then old descriptions are taken from the first parameter with that name found. For example, BGP template and BGP connection uses the same capture, but BGP template is the first one so all the descriptions are taken from there and used for all graft referenced parameters in all menus.

Headings

Currently reference can have only headings that match RouterOS menus, everything else is ignored when comparing previous data.