LogoLogo
  • RouterOS Scripts
  • Scripts
    • Forward log messages via notification
    • Mode button with multiple presses
    • Import SSH keys
    • Act on received SMS
    • Install LTE firmware upgrade
    • Visualize OSPF state via LEDs
    • Use wireless network with daily psk
    • Find and remove access list duplicates
    • Create DNS records for DHCP leases
    • Manage remote logging
    • Forward received SMS
    • Collect MAC addresses in wireless access list
    • Notify about health state
    • Update configuration on IPv6 prefix change
    • Renew certificates and notify on expiration
    • Renew locally issued certificates
    • Upload backup to server
    • Play Super Mario theme
    • Manage IP addresses with bridge status
    • Notify on LTE firmware upgrade
    • Run scripts on ppp connection
    • Run other scripts on DHCP lease
    • Update GRE configuration with dynamic addresses
    • Manage system update
    • Manage LEDs dark mode
    • Upload backup to Mikrotik cloud
    • Send GPS position to server
    • Rotate NTP servers
    • Manage ports in bridge
    • Update tunnelbroker configuration
    • Notify on host up and down
    • Notify on RouterOS update
    • Send notification with early errors
    • Use WPA2 network with hotspot credentials
    • Send backup via e-mail
    • Run rolling CAP upgrades from CAPsMAN
    • Wait for configuration und functions
    • Download packages for CAP upgrade from CAPsMAN
    • Comment DHCP leases with info from access list
  • Initial commands
  • COPYING
Powered by GitBook
On this page
  • Requirements
  • Initial setup
  • Get me ready!
  • The long way in detail
  • Updating scripts
  • Adding a script
  • Scheduler and events
  • Available Scripts

Was this helpful?

RouterOS Scripts

NextScripts

Last updated 4 years ago

Was this helpful?

is the operating system developed by for networking tasks. This repository holds a number of to manage RouterOS devices or extend their functionality.

Use at your own risk, pay attention to !

Requirements

Latest version of the scripts require recent RouterOS to function properly. Make sure to install latest updates before you begin.

Specific scripts may require even newer RouterOS version.

Initial setup

Get me ready!

If you know how things work just copy and paste the . Remember to edit and rerun global-config-overlay! First time users should take the long way below.

Be warned! Some details changed. So see the presentation, then follow the steps below for up-to-date commands.

The long way in detail

The update script does server certificate verification, so first step is to download the certificates. If you intend to download the scripts from a different location (for example from github.com) install the corresponding certificate chain.

[admin@MikroTik] > / tool fetch "https://raw.githubusercontent.com/lupael/routeros-script/master/" dst-path="letsencrypt-R3.pem"
      status: finished
  downloaded: 4KiBC-z pause]
       total: 4KiB
    duration: 1s

Note that the commands above do not verify server certificate, so if you want to be safe download with your workstation's browser and transfer the files to your MikroTik device.

Then we import the certificates.

[admin@MikroTik] > / certificate import file-name=letsencrypt-R3.pem passphrase=""
     certificates-imported: 3
     private-keys-imported: 0
            files-imported: 1
       decryption-failures: 0
  keys-with-no-certificate: 0

For basic verification we rename the certifiactes and print their count. Make sure the certificate count is three.

[admin@MikroTik] > / certificate set name="R3" [ find where fingerprint="67add1166b020ae61b8f5fc96813c04c2aa589960796865572a3c7e737613dfd" ]
[admin@MikroTik] > / certificate set name="ISRG-Root-X1" [ find where fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6" ]
[admin@MikroTik] > / certificate set name="DST-Root-CA-X3" [ find where fingerprint="0687260331a72403d909f105e69bcf0d32e1bd2493ffc6d9206d11bcd6770739" ]
[admin@MikroTik] > / certificate print count-only where fingerprint="67add1166b020ae61b8f5fc96813c04c2aa589960796865572a3c7e737613dfd" or fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6" or fingerprint="0687260331a72403d909f105e69bcf0d32e1bd2493ffc6d9206d11bcd6770739"
3

Always make sure there are no certificates installed you do not know or want!

Now let's download the main scripts and add them in configuration on the fly.

[admin@MikroTik] > :foreach Script in={ "global-config"; "global-config-overlay"; "global-functions" } do={ / system script add name=$Script source=([ / tool fetch check-certificate=yes-without-crl ("https://github.com/lupael/routeros-script.git" . $Script) output=user as-value]->"data"); }

Mark global-config-overlay not to be overwritten by future updates.

[admin@MikroTik] > / system script set comment="ignore" global-config-overlay
[admin@MikroTik] > / system script edit global-config-overlay source

And finally load configuration and functions and add the scheduler.

[admin@MikroTik] > / system script { run global-config; run global-config-overlay; run global-functions; }
[admin@MikroTik] > / system scheduler add name="global-scripts" start-time=startup on-event="/ system script { run global-config; run global-config-overlay; run global-functions; }"

The last step is optional: Add this scheduler only if you want the scripts to be updated automatically!

[admin@MikroTik] > / system scheduler add name="ScriptInstallUpdate" start-time=startup interval=1d on-event=":global ScriptInstallUpdate; \$ScriptInstallUpdate;"

Updating scripts

To update existing scripts just run function $ScriptInstallUpdate.

[admin@MikroTik] > $ScriptInstallUpdate

Adding a script

To add a script from the repository run function $ScriptInstallUpdate with a comma separated list of script names.

[admin@MikroTik] > $ScriptInstallUpdate check-certificates,check-routeros-update

Scheduler and events

[admin@MikroTik] > / system scheduler add name="check-routeros-update" interval=1h on-event="/ system script run check-routeros-update;"

Some events can run a script. If you want your DHCP hostnames to be available in DNS use dhcp-to-dns with the events from dhcp server. For a regular cleanup add a scheduler entry.

[admin@MikroTik] > $ScriptInstallUpdate dhcp-to-dns,lease-script
[admin@MikroTik] > / ip dhcp-server set lease-script=lease-script [ find ]
[admin@MikroTik] > / system scheduler add name="dhcp-to-dns" interval=5m on-event="/ system script run dhcp-to-dns;"

There's much more to explore... Have fun!

Available Scripts

Let's Encrypt

Actually we do not require the certificate named DST Root CA X3, but as it is used by Let's Encrypt to cross-sign we install it anyway - this makes sure things do not go wrong if the intermediate certificate is replaced. The IdenTrust certificate should be available from their . The site is crap and a good example how to not do it.

The configuration needs to be tweaked for your needs. Edit global-config-overlay, copy configuration from (the one without -overlay).

Most scripts are designed to run regularly from . We just added check-routeros-update, so let's run it every hour to make sure not to miss an update.

ISRG Root X1
R3
download page
global-config
scheduler
Find and remove access list duplicates
Manage ports in bridge
Download packages for CAP upgrade from CAPsMAN
Run rolling CAP upgrades from CAPsMAN
Renew locally issued certificates
Renew certificates and notify on expiration
Notify about health state
Notify on LTE firmware upgrade
Notify on RouterOS update
Upload backup to Mikrotik cloud
Collect MAC addresses in wireless access list
Use wireless network with daily psk
Comment DHCP leases with info from access list
Create DNS records for DHCP leases
Send backup via e-mail
Wait for configuration und functions
Send GPS position to server
Use WPA2 network with hotspot credentials
Update configuration on IPv6 prefix change
Manage IP addresses with bridge status
Run other scripts on DHCP lease
Manage LEDs dark mode
Forward log messages via notification
Mode button with multiple presses
Notify on host up and down
Manage remote logging
Visualize OSPF state via LEDs
Manage system update
Run scripts on ppp connection
Rotate NTP servers
Act on received SMS
Forward received SMS
Import SSH keys
Play Super Mario theme
Install LTE firmware upgrade
Update GRE configuration with dynamic addresses
Update tunnelbroker configuration
Upload backup to server
RouterOS
MikroTik
scripts
initial commands
license and warranty
▲ Go back to top