You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Christian Hesse 99a95d310e global-functions: $NotificationFunctions->"email": check for valid settings 3 weeks ago
README.d README: use real screenshots... 1 month ago
certs certs: drop old chain GTS CA 1O1 / GlobalSign 1 month ago
doc doc/accesslist-duplicates: use real screenshot 1 month ago
global-functions.d global-functions.d/notification-telegram: fix calculation on cut off 4 weeks ago
.gitignore ignore all html files 3 years ago
CONTRIBUTIONS.md update list of contributors 2 months ago
COPYING.md explicitly name the license 1 year ago
INITIAL-COMMANDS.md INITIAL-COMMANDS: make github copy function work 5 months ago
Makefile Makefile: generate html files for documentation 4 months ago
README.md README: add a note about date and time 1 month ago
accesslist-duplicates.capsman global: give script or function name in log messages 8 months ago
accesslist-duplicates.local global: give script or function name in log messages 8 months ago
accesslist-duplicates.template global: give script or function name in log messages 8 months ago
bridge-port-to-default global: give script or function name in log messages 8 months ago
bridge-port-toggle global: give script or function name in log messages 8 months ago
capsman-download-packages global: use $0 for $ScriptLock 8 months ago
capsman-rolling-upgrade capsman-rolling-upgrade: properly handle vanished cap 6 months ago
certificate-renew-issued global: give script or function name in log messages 8 months ago
check-certificates check-certificates: fix variable name 5 months ago
check-health check-health: use $ScriptLock 2 months ago
check-lte-firmware-upgrade check-lte-firmware-upgrade: pass origin to $SendNotification2 6 months ago
check-routeros-update check-routeros-update: allow update for cap 4 months ago
cloud-backup packages-update: use 'provides' to find backup scripts 4 months ago
collect-wireless-mac.capsman lease-script: drop differentiation of assign / deassign... 3 months ago
collect-wireless-mac.local lease-script: drop differentiation of assign / deassign... 3 months ago
collect-wireless-mac.template lease-script: drop differentiation of assign / deassign... 3 months ago
daily-psk.capsman daily-psk: pass origin to $SendNotification2 6 months ago
daily-psk.local daily-psk: pass origin to $SendNotification2 6 months ago
daily-psk.template daily-psk: pass origin to $SendNotification2 6 months ago
dhcp-lease-comment.capsman lease-script: drop differentiation of assign / deassign... 3 months ago
dhcp-lease-comment.local lease-script: drop differentiation of assign / deassign... 3 months ago
dhcp-lease-comment.template lease-script: drop differentiation of assign / deassign... 3 months ago
dhcp-to-dns dhcp-to-dns: check for existence of address 2 months ago
email-backup email-backup: warn on missing sensitive information with ROS 7.x 1 month ago
global-config global-functions.d/inspectvar: add $InspectVar... 1 month ago
global-config-overlay global-functions.d/inspectvar: add $InspectVar... 1 month ago
global-config.changes global-functions.d/inspectvar: add $InspectVar... 1 month ago
global-functions global-functions: $NotificationFunctions->"email": check for valid settings 3 weeks ago
gps-track gps-track: silence fetch 8 months ago
hotspot-to-wpa global: give script or function name in log messages 8 months ago
hotspot-to-wpa-cleanup hotspot-to-wpa-cleanup: match dhcp server name 1 month ago
ip-addr-bridge update copyright for 2021 10 months ago
ipsec-to-dns add 'ipsec-to-dns' 5 months ago
ipv6-update ipv6-update: use $LogPrintExit2 4 months ago
learn-mac-based-vlan update copyright for 2021 10 months ago
lease-script lease-script: move debug output up 2 months ago
leds-day-mode update copyright for 2021 10 months ago
leds-night-mode update copyright for 2021 10 months ago
leds-toggle-mode update copyright for 2021 10 months ago
log-forward log-forward: use $HexToNum, do not resend old messages 4 months ago
logo.png logo: clean png export 6 months ago
logo.svg logo: convert text to path 6 months ago
manage-umts update copyright for 2021 10 months ago
mode-button mode-button: use $ValidateSyntax 8 months ago
netwatch-notify netwatch-notify: use $ScriptLock 2 months ago
netwatch-syslog update copyright for 2021 10 months ago
ospf-to-leds ospf-to-leds: do not flood but log properly 4 months ago
packages-update packages-update: use 'provides' to find backup scripts 4 months ago
ppp-on-up ppp-on-up: use $LogPrintExit2 4 months ago
rotate-ntp global: give script or function name in log messages 8 months ago
sms-action sms-action: use $ValidateSyntax 8 months ago
sms-forward sms-forward: pass origin to $SendNotification2 6 months ago
ssh-keys-import update copyright for 2021 10 months ago
super-mario-theme update copyright for 2021 10 months ago
unattended-lte-firmware-upgrade unattended-lte-firmware-upgrade: skip interface on missing firmware information 8 months ago
update-gre-address global: give script or function name in log messages 8 months ago
update-tunnelbroker ppp-on-up: use 'provides' to find ppp-on-up scripts 4 months ago
upload-backup upload-backup: warn on missing sensitive information with ROS 7.x 1 month ago

README.md

RouterOS Scripts

GitHub stars GitHub forks GitHub watchers

RouterOS Scripts Logo

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

Use at your own risk, pay attention to license and warranty!

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 initial commands. Remember to edit and rerun global-config-overlay! First time users should take the long way below.

Live presentation

Want to see it in action? I've had a presentation Repository based RouterOS script distribution including demonstation recorded live at MUM Europe 2019 in Vienna.

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.

/ tool fetch "https://git.eworm.de/cgit/routeros-scripts/plain/certs/R3.pem" dst-path="letsencrypt-R3.pem";

screenshot: download certs

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

Then we import the certificates.

/ certificate import file-name=letsencrypt-R3.pem passphrase="";

screenshot: import certs

For basic verification we rename the certificates and print their count. Make sure the certificate count is two.

/ certificate set name="R3" [ find where fingerprint="67add1166b020ae61b8f5fc96813c04c2aa589960796865572a3c7e737613dfd" ];
/ certificate set name="ISRG-Root-X1" [ find where fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6" ];
/ certificate print count-only where fingerprint="67add1166b020ae61b8f5fc96813c04c2aa589960796865572a3c7e737613dfd" or fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6";

screenshot: check certs

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

All following commands will verify the server certificate. For validity the certificate's lifetime is checked with local time, so make sure the device's date and time is set correctly!

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

: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://git.eworm.de/cgit/routeros-scripts/plain/" . $Script) output=user as-value]->"data"); };

screenshot: import scripts

The configuration needs to be tweaked for your needs. Edit global-config-overlay, copy configuration from global-config (the one without -overlay). Save changes and exit with Ctrl-o.

/ system script edit global-config-overlay source;

screenshot: edit global-config-overlay

And finally load configuration and functions and add the scheduler.

/ system script { run global-config; run global-config-overlay; run global-functions; };
/ system scheduler add name="global-scripts" start-time=startup on-event="/ system script { run global-config; run global-config-overlay; run global-functions; }";

screenshot: run and schedule scripts

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

/ system scheduler add name="ScriptInstallUpdate" start-time=startup interval=1d on-event=":global ScriptInstallUpdate; \$ScriptInstallUpdate;";

screenshot: schedule update

Updating scripts

To update existing scripts just run function $ScriptInstallUpdate. If everything is up-to-date it will not produce any output.

$ScriptInstallUpdate;

screenshot: update scripts

Adding a script

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

$ScriptInstallUpdate check-certificates,check-routeros-update;

screenshot: install scripts

Scheduler and events

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

/ system scheduler add name="check-routeros-update" interval=1h on-event="/ system script run check-routeros-update;";

screenshot: schedule script

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.

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

screenshot: setup lease script

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

Available Scripts

Contact

We have a Telegram Group RouterOS-Scripts! Get help, give feedback or just chat - but do not expect free professional support!

Contribute

Thanks a lot for past contributions!

Patches, issues and whishlist

Feel free to contact me via e-mail or open an issue at github.

Donate

This project is developed in private spare time and usage is free of charge for you. If you like the scripts and think this is of value for you or your business please consider to donate with PayPal.

donate with PayPal

Thanks a lot for your support!

License and warranty

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Upstream

URL: GitHub.com

Mirror: eworm.de GitLab.com


▲ Go back to top