Skip to main content
Version: current

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​

  • enum-arg - enumerator
  • num-arg - unsigned integer, can have a specific range for example [3 .. 20], [.. 10], [4 ..], or 32-bit range if not explicitly specified
  • bool-arg - boolean, can have true or false values
  • switch-arg -
  • ubit-arg - typically have predefined bit values which are listed in braces, for example ( ip, ipv6, l2vpn)
  • sbit-arg -
  • mac_arg - MAC address
  • ip_arg - ipv4 address
  • ip6_arg - ipv6 address
  • addr_arg - universal address parameter whichcan have several different flags:
    • 4 - IPv4 address
    • 6 - IPv6 address
    • i - interface
    • / - address can have subnet mask
    • v - vrf
    • R - route distinguisher
    • S - allows to write prefix in free form (for example EVPN prefix is using it)
    • + - address list
    • : -
    • L -

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 orute menus, everything else is ignored when comparing previous data.