add doc/collect-wireless-mac.md

This commit is contained in:
Christian Hesse 2020-03-27 21:43:01 +01:00
parent d1bba48cc7
commit 79e7b3229f
4 changed files with 57 additions and 0 deletions

View file

@ -3,6 +3,7 @@
# Copyright (c) 2013-2020 Christian Hesse <mail@eworm.de>
#
# collect wireless mac adresses in access list
# https://git.eworm.de/cgit/routeros-scripts/about/doc/collect-wireless-mac.md
#
# !! Do not edit this file, it is generated from template!

View file

@ -3,6 +3,7 @@
# Copyright (c) 2013-2020 Christian Hesse <mail@eworm.de>
#
# collect wireless mac adresses in access list
# https://git.eworm.de/cgit/routeros-scripts/about/doc/collect-wireless-mac.md
#
# !! Do not edit this file, it is generated from template!

View file

@ -3,6 +3,7 @@
# Copyright (c) 2013-2020 Christian Hesse <mail@eworm.de>
#
# collect wireless mac adresses in access list
# https://git.eworm.de/cgit/routeros-scripts/about/doc/collect-wireless-mac.md
#
# !! This is just a template! Replace '%PATH%' with 'caps-man'
# !! or 'interface wireless'!

View file

@ -0,0 +1,54 @@
Collect MAC addresses in wireless access list
=============================================
[◀ Go back to main README](../README.md)
Description
-----------
This script adds unknown MAC addresses of connected wireless devices to
address list. In addition a notification is sent.
By default the access list entry is disabled, but you can easily enable
and modify it to your needs.
Requirements and installation
-----------------------------
Depending on whether you use CAPsMAN (`/ caps-man`) or local wireless
interface (`/ interface wireless`) you need to install a different script.
For CAPsMAN:
$ScriptInstallUpdate collect-wireless-mac.capsman;
For local interface:
$ScriptInstallUpdate collect-wireless-mac.local;
Configuration
-------------
On first run a disabled access list entry acting as marker (with comment
"`--- collected above ---`") is added. Move this entry to define where new
entries are to be added.
Also notification settings are required for e-mail and telegram.
Usage and invocation
--------------------
Run this script from a dhcp server as lease-script to collect the MAC
address when a new address is leased. You may want to use
[lease-script](lease-script.md).
See also
--------
* [Comment DHCP leases with info from access list](dhcp-lease-comment.md)
* [Create DNS records for DHCP leases](dhcp-to-dns.md)
* [Run other scripts on DHCP lease](lease-script.md)
---
[◀ Go back to main README](../README.md)
[▲ Go back to top](#top)