aboutsummaryrefslogtreecommitdiffstats
path: root/doc/global-functions.d
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2021-11-15 20:22:56 +0100
committerGravatar Christian Hesse <mail@eworm.de>2021-11-15 22:18:10 +0100
commit8fc88c73f8cb99774727e7b96f9b85a8bf216c2c (patch)
treee5a36de5fd846a210088b2a21bd436f3f53b4805 /doc/global-functions.d
parentf484e45b6a1fe5284462da19c90219d0716d916a (diff)
shorten modules directory name (global-functions.d -> mod)change-67
Diffstat (limited to 'doc/global-functions.d')
-rw-r--r--doc/global-functions.d/bridge-port-to.md79
-rw-r--r--doc/global-functions.d/bridge-port-vlan.md83
2 files changed, 0 insertions, 162 deletions
diff --git a/doc/global-functions.d/bridge-port-to.md b/doc/global-functions.d/bridge-port-to.md
deleted file mode 100644
index e0eba1e..0000000
--- a/doc/global-functions.d/bridge-port-to.md
+++ /dev/null
@@ -1,79 +0,0 @@
-Manage ports in bridge
-======================
-
-[◀ 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 functio are are supposed to handle interfaces and
-switching them from one bridge to another.
-
-Requirements and installation
------------------------------
-
-Just install the module:
-
- $ScriptInstallUpdate global-functions.d/bridge-port-to;
-
-Configuration
--------------
-
-The configuration goes to ports' comments (`/ interface bridge port`).
-
- / interface bridge port add bridge=br-guest comment="default=dhcp-client, alt=br-guest" disabled=yes interface=en1;
- / interface bridge port add bridge=br-intern comment="default=br-intern, alt=br-guest" interface=en2;
- / interface bridge port add bridge=br-guest comment="default=br-guest, extra=br-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-to on-event=":global GlobalFunctionsReady; :while (\$GlobalFunctionsReady != true) do={ :delay 500ms; }; :global BridgePortTo; \$BridgePortTo default;" start-time=startup;
-
-Usage and invocation
---------------------
-
-The usage examples show what happens with the configuration from above.
-
-Running the function `$BridgePortTo` with parameter `default` applies all
-configuration given with `default=`:
-
- $BridgePortTo 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.
-* Interface `en2` is put in bridge `br-intern`.
-* Interface `en3` is put in bridge `br-guest`.
-
-Running the function `$BridgePortTo` with parameter `alt` applies all
-configuration given with `alt=`:
-
- $BridgePortTo alt;
-
-* Interface `en1` is put in bridge `br-guest`, dhcp client for the interface is disabled.
-* Interface `en2` is put in bridge `br-guest`.
-* Interface `en3` is unchanged, stays in bridge `br-guest`.
-
-Running the function `$BridgePortTo` with parameter `extra` applies another
-configuration:
-
- $BridgePortTo extra;
-
-* Interfaces `en1` and `en2` are unchanged.
-* Interface `en3` is put in bridge `br-intern`.
-
-See also
---------
-
-* [Manage VLANs on bridge ports](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
deleted file mode 100644
index 9df46b0..0000000
--- a/doc/global-functions.d/bridge-port-vlan.md
+++ /dev/null
@@ -1,83 +0,0 @@
-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-to.md)
-
----
-[◀ Go back to main README](../../README.md)
-[▲ Go back to top](#top)