mirror of
https://github.com/eworm-de/routeros-scripts
synced 2024-05-14 08:04:19 +00:00
870f00bb36
___ _ ___ __
/ _ )(_)__ _ / _/__ _/ /_
/ _ / / _ `/ / _/ _ `/ __/
/____/_/\_, / /_/ \_,_/\__/
_ __ /___/ _ __
| | / /___ __________ (_)___ ____ _/ /
| | /| / / __ `/ ___/ __ \/ / __ \/ __ `/ /
| |/ |/ / /_/ / / / / / / / / / / /_/ /_/
|__/|__/\__,_/_/ /_/ /_/_/_/ /_/\__, (_)
/____/
RouterOS has some odd behavior when it comes to variable names. Let's
have a look at the interfaces:
[admin@MikroTik] > / interface print where name=en1
Flags: D - dynamic, X - disabled, R - running, S - slave
# NAME TYPE ACTUAL-MTU L2MTU
0 RS en1 ether 1500 1598
That looks ok. Now we use a script:
{ :local interface "en1";
/ interface print where name=$interface; }
And the result...
[admin@MikroTik] > { :local interface "en1";
{... / interface print where name=$interface; }
Flags: D - dynamic, X - disabled, R - running, S - slave
# NAME TYPE ACTUAL-MTU L2MTU
0 RS en1 ether 1500 1598
... still looks ok.
We make a little modification to the script:
{ :local name "en1";
/ interface print where name=$name; }
And the result:
[admin@MikroTik] > { :local name "en1";
{... / interface print where name=$name; }
Flags: D - dynamic, X - disabled, R - running, S - slave
# NAME TYPE ACTUAL-MTU L2MTU
0 RS en1 ether 1500 1598
1 S en2 ether 1500 1598
2 S en3 ether 1500 1598
3 S en4 ether 1500 1598
4 S en5 ether 1500 1598
5 R br-local bridge 1500 1598
Ups! The filter has no effect!
That happens whenever the variable name ($name) matches the property
name (name=).
And another modification:
{ :local type "en1";
/ interface print where name=$type; }
And the result:
[admin@MikroTik] > { :local type "en1";
{... / interface print where name=$type; }
Flags: D - dynamic, X - disabled, R - running, S - slave
# NAME TYPE ACTUAL-MTU L2MTU
Ups! Nothing?
Even if the variable name ($type) matches whatever property name (type=)
things go wrong.
The answer from MikroTik support (in Ticket#2019010222000454):
> This is how scripting works in RouterOS and we will not fix it.
To get around this we use variable names in CamelCase. Let's hope
Mikrotik never ever introduces property names in CamelCase...
*fingers crossed*
143 lines
5.9 KiB
Markdown
143 lines
5.9 KiB
Markdown
RouterOS Scripts
|
|
================
|
|
|
|
[RouterOS](https://mikrotik.com/software) is the operating system developed
|
|
by [MikroTik](https://mikrotik.com/aboutus) for networking tasks. This
|
|
repository holds a number of [scripts](https://wiki.mikrotik.com/wiki/Manual:Scripting)
|
|
to manage RouterOS devices or extend their functionality.
|
|
|
|
*Use at your own risk!*
|
|
|
|
Requirements
|
|
------------
|
|
|
|
Latest version of the scripts require at least **RouterOS 6.43** to function
|
|
properly. The changelog lists the corresponding change as follows:
|
|
|
|
> *) fetch - added "as-value" output format;
|
|
|
|
See branch `pre-6-43` if you want to use the scripts on devices with older
|
|
RouterOS version.
|
|
|
|
Initial setup
|
|
-------------
|
|
|
|
### Get me ready!
|
|
|
|
If you know how things work just copy and paste the
|
|
[initial commands](initial-commands). Remember to edit and rerun
|
|
`global-config`!
|
|
First time useres should take the long way below.
|
|
|
|
### 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://git.eworm.de/cgit.cgi/routeros-scripts/plain/certs/letsencrypt.pem" dst-path="letsencrypt.pem"
|
|
status: finished
|
|
downloaded: 3KiBC-z pause]
|
|
total: 3KiB
|
|
duration: 1s
|
|
|
|
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.
|
|
|
|
* [ISRG Root X1](https://letsencrypt.org/certs/isrgrootx1.pem.txt)
|
|
* [Let's Encrypt Authority X3](https://letsencrypt.org/certs/letsencryptauthorityx3.pem.txt)
|
|
|
|
Then we import the certificates.
|
|
|
|
[admin@MikroTik] > / certificate import file-name=letsencrypt.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="ISRG-Root-X1" [ find where fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6" ]
|
|
[admin@MikroTik] > / certificate set name="Let-s-Encrypt-Authority-X3" [ find where fingerprint="731d3d9cfaa061487a1d71445a42f67df0afca2a6c2d2f98ff7b3ce112b1f568" ]
|
|
[admin@MikroTik] > / certificate set name="DST-Root-CA-X3" [ find where fingerprint="0687260331a72403d909f105e69bcf0d32e1bd2493ffc6d9206d11bcd6770739" ]
|
|
[admin@MikroTik] > / certificate print count-only where fingerprint="96bcec06264976f37460779acf28c5a7cfe8a3c0aae11a8ffcee05c0bddf08c6" or fingerprint="731d3d9cfaa061487a1d71445a42f67df0afca2a6c2d2f98ff7b3ce112b1f568" or fingerprint="0687260331a72403d909f105e69bcf0d32e1bd2493ffc6d9206d11bcd6770739"
|
|
3
|
|
|
|
Always make sure there are no certificates installed you do not know or want!
|
|
|
|
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
|
|
[download page](https://www.identrust.com/support/downloads). The site is
|
|
crap and a good example how to *not* do it.
|
|
|
|
Now let's download the main scripts and add them in configuration on the fly.
|
|
|
|
[admin@MikroTik] > :foreach Script in={ "global-config"; "global-functions"; "script-updates" } do={ / system script add name=$Script source=([ / tool fetch check-certificate=yes-without-crl ("https://git.eworm.de/cgit.cgi/routeros-scripts/plain/" . $Script) output=user as-value]->"data"); }
|
|
|
|
The configuration needs to be tweaked for your needs. Make sure not to send
|
|
your mails to `mail@example.com`!
|
|
|
|
[admin@MikroTik] > / system script edit global-config source
|
|
|
|
And finally load configuration and functions and add the schedulers.
|
|
|
|
[admin@MikroTik] > / system script run global-config
|
|
[admin@MikroTik] > / system script run global-functions
|
|
[admin@MikroTik] > / system scheduler add name=global-config start-time=startup on-event=global-config
|
|
[admin@MikroTik] > / system scheduler add name=global-functions start-time=startup on-event=global-functions
|
|
|
|
Updating scripts
|
|
----------------
|
|
|
|
To update existing scripts just run `script-updates`.
|
|
|
|
[admin@MikroTik] > / system script run script-updates
|
|
|
|
Adding a script
|
|
---------------
|
|
|
|
To add a script from the repository create a configuration item first, then
|
|
update scripts to fetch the source.
|
|
|
|
[admin@MikroTik] > / system script add name=check-routeros-update
|
|
[admin@MikroTik] > / system script run script-updates
|
|
|
|
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.
|
|
|
|
[admin@MikroTik] > / system scheduler add name=check-routeros-update interval=1h on-event=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] > / system script add name=dhcp-to-dns
|
|
[admin@MikroTik] > / system script run script-updates
|
|
[admin@MikroTik] > / ip dhcp-server set lease-script=dhcp-to-dns [ find ]
|
|
[admin@MikroTik] > / system scheduler add name=dhcp-to-dns interval=5m on-event=dhcp-to-dns
|
|
|
|
There's much more to explore... Have fun!
|
|
|
|
### Upstream
|
|
|
|
URL:
|
|
[GitHub.com](https://github.com/eworm-de/routeros-scripts#routeros-scripts)
|
|
|
|
Mirror:
|
|
[eworm.de](https://git.eworm.de/cgit.cgi/routeros-scripts/about/)
|
|
[GitLab.com](https://gitlab.com/eworm-de/routeros-scripts#routeros-scripts)
|
|
|
|
---
|
|
[▲ Go back to top](#top)
|