From b6215ba95899328bd13fabbf6488b602763b9352 Mon Sep 17 00:00:00 2001
From: Christian Hesse <mail@eworm.de>
Date: Thu, 11 Nov 2021 14:44:26 +0100
Subject: add global-functions.d/bridge-port-vlan

---
 doc/bridge-port.md                         |  5 ++
 doc/global-functions.d/bridge-port-vlan.md | 83 ++++++++++++++++++++++++++++++
 2 files changed, 88 insertions(+)
 create mode 100644 doc/global-functions.d/bridge-port-vlan.md

(limited to 'doc')

diff --git a/doc/bridge-port.md b/doc/bridge-port.md
index d5435b4..924bd6a 100644
--- a/doc/bridge-port.md
+++ b/doc/bridge-port.md
@@ -76,6 +76,11 @@ More configuration can be loaded by setting `BridgePortTo`:
 * Interfaces `en1` and `en2` are unchanged.
 * Interface `en3` is put in bridge `br-intern`.
 
+See also
+--------
+
+* [Manage VLANs on bridge ports](global-functions.d/bridge-port-vlan.md)
+
 ---
 [◀ Go back to main README](../README.md)  
 [▲ Go back to top](#top)
diff --git a/doc/global-functions.d/bridge-port-vlan.md b/doc/global-functions.d/bridge-port-vlan.md
new file mode 100644
index 0000000..f59cb83
--- /dev/null
+++ b/doc/global-functions.d/bridge-port-vlan.md
@@ -0,0 +1,83 @@
+Manage VLANs on bridge ports
+============================
+
+[◀ Go back to main README](../../README.md)
+
+🛈 This module can not be used on its own but requires the base installation.
+See [main README](../../README.md) for details.
+
+Description
+-----------
+
+This module and its function are supposed to handle VLANs on bridge ports.
+
+Requirements and installation
+-----------------------------
+
+Just install the module:
+
+    $ScriptInstallUpdate global-functions.d/bridge-port-vlan;
+
+Configuration
+-------------
+
+Using named VLANs you have to add comments in bridge vlan menu:
+
+    / interface bridge vlan add bridge=bridge comment=intern tagged=br-local vlan-ids=10;
+    / interface bridge vlan add bridge=bridge comment=geust tagged=br-local vlan-ids=20;
+    / interface bridge vlan add bridge=bridge comment=extra tagged=br-local vlan-ids=30;
+
+The configuration goes to ports' comments (`/ interface bridge port`).
+
+    / interface bridge port add bridge=bridge comment="default=dhcp-client, alt=guest" disabled=yes interface=en1;
+    / interface bridge port add bridge=bridge comment="default=intern, alt=guest, extra=30" interface=en2;
+    / interface bridge port add bridge=bridge comment="default=guest, extra=extra" interface=en3;
+
+Also dhcp client can be handled:
+
+    / ip dhcp-client add comment="toggle with bridge port" disabled=no interface=en1;
+
+Add a scheduler to start with default setup on system startup:
+
+    / system scheduler add name=bridge-port-vlan on-event=":global GlobalFunctionsReady; :while (\$GlobalFunctionsReady != true) do={ :delay 500ms; }; :global BridgePortVlan; \$BridgePortVlan default;" start-time=startup;
+
+Usage and invocation
+--------------------
+
+The usage examples show what happens with the configuration from above.
+
+Running the function `$BridgePortVlan` with parameter `default` applies all
+configuration given with `default=`:
+
+    $BridgePortVlan default;
+
+For the three interfaces we get this configuration:
+
+* The special value `dhcp-client` enables the dhcp client for interface `en1`. The bridge port entry is disabled.
+* Primary VLAN `intern` (ID `10`) is configured on `en2`.
+* Primary VLAN `guest` (ID `20`) is configured on `en3`.
+
+Running the function `$BridgePortVlan` with parameter `alt` applies all
+configuration given with `alt=`:
+
+    $BridgePortVlan alt;
+
+* Primary VLAN `guest` (ID `20`) is configured on `en1`, dhcp client for the interface is disabled.
+* Primary VLAN `guest` (ID `20`) is configured on `en2`.
+* Interface `en3` is unchanged, primary VLAN `guest` (ID `20`) is unchanged.
+
+Running the function `$BridgePortVlan` with parameter `extra` applies another
+configuration:
+
+* Interface `en1` is unchanged.
+* Primary VLAN `extra` (via its ID `30`) is configured on `en2`.
+* Primary VLAN `extra` (ID `30`) is configured on `en3`.
+
+See also
+--------
+
+* [Manage ports in bridge](../bridge-port.md)
+
+---
+[◀ Go back to main README](../../README.md)  
+[▲ Go back to top](#top)
-- 
cgit v1.2.3-54-g00ecf