2018-07-03 18:46:57 +00:00
RouterOS Scripts
================
2020-03-30 14:30:25 +00:00
[](https://github.com/eworm-de/routeros-scripts/stargazers)
2021-02-21 20:59:36 +00:00
[](https://github.com/eworm-de/routeros-scripts/network)
2020-03-30 14:30:25 +00:00
[](https://github.com/eworm-de/routeros-scripts/watchers)
2020-03-30 14:18:47 +00:00
2021-05-07 07:13:09 +00:00
2021-04-28 11:57:04 +00:00
2018-07-03 18:46:57 +00:00
[RouterOS ](https://mikrotik.com/software ) is the operating system developed
2018-08-24 20:43:19 +00:00
by [MikroTik ](https://mikrotik.com/aboutus ) for networking tasks. This
2018-07-03 18:46:57 +00:00
repository holds a number of [scripts ](https://wiki.mikrotik.com/wiki/Manual:Scripting )
to manage RouterOS devices or extend their functionality.
2020-06-19 20:17:42 +00:00
*Use at your own risk*, pay attention to
[license and warranty ](#license-and-warranty )!
2018-08-24 20:43:19 +00:00
2018-08-27 06:59:05 +00:00
Requirements
------------
2020-05-04 12:08:49 +00:00
Latest version of the scripts require recent RouterOS to function properly.
Make sure to install latest updates before you begin.
2018-08-27 06:59:05 +00:00
2020-05-04 12:08:49 +00:00
Specific scripts may require even newer RouterOS version.
2019-04-01 08:41:42 +00:00
2018-08-24 20:43:19 +00:00
Initial setup
-------------
2018-12-17 22:15:23 +00:00
### Get me ready!
If you know how things work just copy and paste the
2020-03-20 11:51:28 +00:00
[initial commands ](INITIAL-COMMANDS.md ). Remember to edit and rerun
2019-09-03 18:59:00 +00:00
`global-config-overlay` !
2019-11-04 23:28:30 +00:00
First time users should take the long way below.
2018-12-17 22:15:23 +00:00
2019-03-12 20:00:39 +00:00
### Live presentation
Want to see it in action? I've had a presentation [Repository based
RouterOS script distribution](https://www.youtube.com/watch?v=B9neG3oAhcY)
including demonstation recorded live at [MUM Europe
2019](https://mum.mikrotik.com/2019/EU/) in Vienna.
2020-05-04 12:14:42 +00:00
*Be warned!* Some details changed. So see the presentation, then follow
the steps below for up-to-date commands.
2018-12-17 22:15:23 +00:00
### The long way in detail
2018-08-24 20:43:19 +00:00
The update script does server certificate verification, so first step is to
2018-09-14 18:40:21 +00:00
download the certificates. If you intend to download the scripts from a
different location (for example from github.com) install the corresponding
certificate chain.
2018-08-24 20:43:19 +00:00
2021-09-21 11:58:09 +00:00
/ tool fetch "https://git.eworm.de/cgit/routeros-scripts/plain/certs/R3.pem" dst-path="letsencrypt-R3.pem";
2020-12-17 21:00:13 +00:00
2018-08-24 20:43:19 +00:00
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.
2020-12-17 21:00:13 +00:00
* [ISRG Root X1 ](https://letsencrypt.org/certs/isrgrootx1.pem )
* Let's Encrypt [R3 ](https://letsencrypt.org/certs/lets-encrypt-r3.pem )
2018-08-24 20:43:19 +00:00
Then we import the certificates.
2021-09-21 11:58:09 +00:00
/ certificate import file-name=letsencrypt-R3.pem passphrase="";
2018-08-24 20:43:19 +00:00
2021-02-18 10:30:04 +00:00
For basic verification we rename the certificates and print their count. Make
2019-04-30 13:11:54 +00:00
sure the certificate count is **two** .
2018-09-14 08:31:11 +00:00
2021-09-21 11:58:09 +00:00
/ 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";
2018-09-14 08:31:11 +00:00
2018-09-14 18:40:21 +00:00
Always make sure there are no certificates installed you do not know or want!
2021-09-21 19:53:51 +00:00
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!
2018-09-14 08:31:11 +00:00
Now let's download the main scripts and add them in configuration on the fly.
2018-08-24 20:43:19 +00:00
2021-09-21 11:58:09 +00:00
: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"); };
2018-08-24 20:43:19 +00:00
2020-10-15 20:45:27 +00:00
The configuration needs to be tweaked for your needs. Edit
2020-10-15 20:50:12 +00:00
`global-config-overlay` , copy configuration from
[`global-config` ](global-config ) (the one without `-overlay` ).
2021-09-21 11:58:09 +00:00
Save changes and exit with `Ctrl-o` .
/ system script edit global-config-overlay source;
2018-08-24 20:43:19 +00:00
2021-09-21 11:58:09 +00:00
2018-08-24 20:43:19 +00:00
2019-09-03 18:36:13 +00:00
And finally load configuration and functions and add the scheduler.
2018-08-24 20:43:19 +00:00
2021-12-07 14:40:14 +00:00
/ system script { run global-config; run global-functions; };
/ system scheduler add name="global-scripts" start-time=startup on-event="/ system script { run global-config; run global-functions; }";
2021-09-21 11:58:09 +00:00
2018-08-24 20:43:19 +00:00
2020-11-01 21:20:02 +00:00
The last step is optional: Add this scheduler **only** if you want the scripts
to be updated automatically!
2021-09-21 11:58:09 +00:00
/ system scheduler add name="ScriptInstallUpdate" start-time=startup interval=1d on-event=":global ScriptInstallUpdate; \$ScriptInstallUpdate;";
2020-11-01 21:20:02 +00:00
2021-12-13 10:36:03 +00:00
### Changes for RouterOS v6
RouterOS v6 will become deprecated at some time in the future, but to date
it is still the default for these scripts (in branch `main` ). This will
change however, so if you want to stay with RouterOS v6 for some time add
these lines to your `global-config-overlay` :
# Use branch routeros-v6 with RouterOS v6:
:global ScriptUpdatesUrlSuffix "\?h=routeros-v6";
Then reload the configuration.
2021-12-07 10:04:50 +00:00
### Changes for RouterOS v7
RouterOS v7 is developed in paralled to RouterOS v6. The former brings some
shiny new features, the latter provides proven stability.
The changes require incompatible changes to scripts, so these changes go to
a separate branch. If you decide to run RouterOS v7 please switch to branch
`routeros-v7` by adding these lines to your `global-config-overlay` :
# Use branch routeros-v7 with RouterOS v7:
:global ScriptUpdatesUrlSuffix "\?h=routeros-v7";
Then reload the configuration and continue below to update scripts.
2018-08-24 20:43:19 +00:00
Updating scripts
----------------
2021-09-21 11:58:09 +00:00
To update existing scripts just run function `$ScriptInstallUpdate` . If
everything is up-to-date it will not produce any output.
$ScriptInstallUpdate;
2020-01-29 21:10:33 +00:00
2021-09-21 11:58:09 +00:00
2020-01-29 21:10:33 +00:00
2018-08-24 20:43:19 +00:00
Adding a script
---------------
2020-01-29 21:10:33 +00:00
To add a script from the repository run function `$ScriptInstallUpdate` with
a comma separated list of script names.
2018-08-24 20:43:19 +00:00
2021-09-21 11:58:09 +00:00
$ScriptInstallUpdate check-certificates,check-routeros-update;
2018-08-24 20:43:19 +00:00
Scheduler and events
--------------------
Most scripts are designed to run regularly from
[scheduler ](https://wiki.mikrotik.com/wiki/Manual:System/Scheduler ). We just
added `check-routeros-update` , so let's run it every hour to make sure not to
miss an update.
2021-09-21 11:58:09 +00:00
/ system scheduler add name="check-routeros-update" interval=1h on-event="/ system script run check-routeros-update;";
2018-08-24 20:43:19 +00:00
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.
2021-09-21 11:58:09 +00:00
$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;";
2018-08-24 20:43:19 +00:00
There's much more to explore... Have fun!
2018-07-03 18:46:57 +00:00
2021-11-18 09:27:44 +00:00
Available scripts
2020-03-27 20:54:59 +00:00
-----------------
* [Find and remove access list duplicates ](doc/accesslist-duplicates.md )
* [Download packages for CAP upgrade from CAPsMAN ](doc/capsman-download-packages.md )
* [Run rolling CAP upgrades from CAPsMAN ](doc/capsman-rolling-upgrade.md )
* [Renew locally issued certificates ](doc/certificate-renew-issued.md )
* [Renew certificates and notify on expiration ](doc/check-certificates.md )
* [Notify about health state ](doc/check-health.md )
* [Notify on LTE firmware upgrade ](doc/check-lte-firmware-upgrade.md )
* [Notify on RouterOS update ](doc/check-routeros-update.md )
* [Upload backup to Mikrotik cloud ](doc/cloud-backup.md )
* [Collect MAC addresses in wireless access list ](doc/collect-wireless-mac.md )
* [Use wireless network with daily psk ](doc/daily-psk.md )
* [Comment DHCP leases with info from access list ](doc/dhcp-lease-comment.md )
* [Create DNS records for DHCP leases ](doc/dhcp-to-dns.md )
* [Send backup via e-mail ](doc/email-backup.md )
2021-11-15 21:17:43 +00:00
* [Wait for global functions und modules ](doc/global-wait.md )
2020-03-27 20:54:59 +00:00
* [Send GPS position to server ](doc/gps-track.md )
* [Use WPA2 network with hotspot credentials ](doc/hotspot-to-wpa.md )
2021-05-17 14:32:07 +00:00
* [Create DNS records for IPSec peers ](doc/ipsec-to-dns.md )
2020-03-27 20:54:59 +00:00
* [Update configuration on IPv6 prefix change ](doc/ipv6-update.md )
* [Manage IP addresses with bridge status ](doc/ip-addr-bridge.md )
* [Run other scripts on DHCP lease ](doc/lease-script.md )
* [Manage LEDs dark mode ](doc/leds-mode.md )
2020-07-15 10:22:55 +00:00
* [Forward log messages via notification ](doc/log-forward.md )
2020-08-13 11:07:40 +00:00
* [Mode button with multiple presses ](doc/mode-button.md )
2020-03-27 20:54:59 +00:00
* [Notify on host up and down ](doc/netwatch-notify.md )
* [Manage remote logging ](doc/netwatch-syslog.md )
2020-10-23 12:13:40 +00:00
* [Visualize OSPF state via LEDs ](doc/ospf-to-leds.md )
2020-03-27 20:54:59 +00:00
* [Manage system update ](doc/packages-update.md )
* [Run scripts on ppp connection ](doc/ppp-on-up.md )
* [Rotate NTP servers ](doc/rotate-ntp.md )
* [Act on received SMS ](doc/sms-action.md )
* [Forward received SMS ](doc/sms-forward.md )
* [Import SSH keys ](doc/ssh-keys-import.md )
* [Play Super Mario theme ](doc/super-mario-theme.md )
* [Install LTE firmware upgrade ](doc/unattended-lte-firmware-upgrade.md )
* [Update GRE configuration with dynamic addresses ](doc/update-gre-address.md )
* [Update tunnelbroker configuration ](doc/update-tunnelbroker.md )
* [Upload backup to server ](doc/upload-backup.md )
[comment]: # (TODO: currently undocumented)
[comment]: # (* learn-mac-based-vlan)
[comment]: # (* manage-umts)
2021-11-11 13:44:26 +00:00
Available modules
-----------------
2021-11-15 19:22:56 +00:00
* [Manage ports in bridge ](doc/mod/bridge-port-to.md )
* [Manage VLANs on bridge ports ](doc/mod/bridge-port-vlan.md )
2021-11-11 13:44:26 +00:00
2021-02-22 09:34:09 +00:00
Contact
-------
We have a Telegram Group [RouterOS-Scripts ](https://t.me/routeros_scripts )!
2021-12-30 22:45:57 +00:00
2021-02-22 09:34:09 +00:00
Get help, give feedback or just chat - but do not expect free professional
support!
2020-03-26 06:53:44 +00:00
Contribute
----------
2019-08-30 08:42:33 +00:00
2019-08-30 09:47:44 +00:00
Thanks a lot for [past contributions ](CONTRIBUTIONS.md )!
2019-08-30 08:42:33 +00:00
### Patches, issues and whishlist
Feel free to contact me via e-mail or open an
[issue at github ](https://github.com/eworm-de/routeros-scripts/issues ).
### 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 ](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J ).
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick& hosted_button_id=A4ZXBD6YS2W8J)
Thanks a lot for your support!
2020-06-19 20:17:42 +00:00
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 ](COPYING.md ) for more details.
2020-03-26 06:53:44 +00:00
Upstream
--------
2018-07-03 18:46:57 +00:00
URL:
[GitHub.com ](https://github.com/eworm-de/routeros-scripts#routeros-scripts )
Mirror:
2019-08-30 11:28:14 +00:00
[eworm.de ](https://git.eworm.de/cgit/routeros-scripts/about/ )
2018-07-03 18:46:57 +00:00
[GitLab.com ](https://gitlab.com/eworm-de/routeros-scripts#routeros-scripts )
2019-01-02 20:04:54 +00:00
---
[▲ Go back to top ](#top )
