From f484e45b6a1fe5284462da19c90219d0716d916a Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Fri, 12 Nov 2021 14:10:13 +0100 Subject: bridge-port-to-default -> global-functions.d/bridge-port-to --- doc/bridge-port.md | 86 ------------------------------ doc/global-functions.d/bridge-port-to.md | 79 +++++++++++++++++++++++++++ doc/global-functions.d/bridge-port-vlan.md | 2 +- 3 files changed, 80 insertions(+), 87 deletions(-) delete mode 100644 doc/bridge-port.md create mode 100644 doc/global-functions.d/bridge-port-to.md (limited to 'doc') diff --git a/doc/bridge-port.md b/doc/bridge-port.md deleted file mode 100644 index 924bd6a..0000000 --- a/doc/bridge-port.md +++ /dev/null @@ -1,86 +0,0 @@ -Manage ports in bridge -====================== - -[◀ Go back to main README](../README.md) - -🛈 This script can not be used on its own but requires the base installation. -See [main README](../README.md) for details. - -Description ------------ - -These scripts are supposed to handle interfaces and switching them from -one bridge to another. - -Requirements and installation ------------------------------ - -Just install the scripts: - - $ScriptInstallUpdate bridge-port-to-default,bridge-port-toggle; - -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; - -There is also global configuration: - -* `BridgePortTo`: specify the configuration to be applied by default - -Add a scheduler to start with default setup on system startup: - - / system scheduler add name=bridge-port-to-default on-event="/ system script run bridge-port-to-default;" start-time=startup; - -Usage and invocation --------------------- - -The usage examples show what happens with the configuration from above. - -Running the script `bridge-port-to-default` applies all configuration given -with `default=`: - - / system script run bridge-port-to-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 script `bridge-port-toggle` toggles to configuration given -with `alt=`: - - / system script run bridge-port-toggle; - -* 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 script `bridge-port-toggle` again toggles back to configuration -given with `default=`. - -More configuration can be loaded by setting `BridgePortTo`: - - :set BridgePortTo "extra"; - / system script run bridge-port-to-default; - -* 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-to.md b/doc/global-functions.d/bridge-port-to.md new file mode 100644 index 0000000..e0eba1e --- /dev/null +++ b/doc/global-functions.d/bridge-port-to.md @@ -0,0 +1,79 @@ +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 index f59cb83..9df46b0 100644 --- a/doc/global-functions.d/bridge-port-vlan.md +++ b/doc/global-functions.d/bridge-port-vlan.md @@ -76,7 +76,7 @@ configuration: See also -------- -* [Manage ports in bridge](../bridge-port.md) +* [Manage ports in bridge](bridge-port-to.md) --- [◀ Go back to main README](../../README.md) -- cgit v1.2.3-54-g00ecf