routeros-scripts/doc/mod/bridge-port-to.md

82 lines
2.5 KiB
Markdown
Raw Normal View History

2020-03-27 20:39:37 +00:00
Manage ports in bridge
======================
[◀ Go back to main README](../../README.md)
2020-03-27 20:39:37 +00:00
> **Info**: This module can not be used on its own but requires the base
> installation. See [main README](../../README.md) for details.
2020-03-27 20:39:37 +00:00
Description
-----------
This module and its functio are are supposed to handle interfaces and
switching them from one bridge to another.
2020-03-27 20:39:37 +00:00
Requirements and installation
-----------------------------
Just install the module:
2020-03-27 20:39:37 +00:00
$ScriptInstallUpdate mod/bridge-port-to;
2020-03-27 20:39:37 +00:00
Configuration
-------------
The configuration goes to ports' comments (`/interface/bridge/port`).
2020-03-27 20:39:37 +00:00
/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;
2020-03-27 20:39:37 +00:00
Also dhcp client can be handled:
/ip/dhcp-client/add comment="toggle with bridge port" disabled=no interface=en1;
2020-03-27 20:39:37 +00:00
Add a scheduler to start with default setup on system startup:
2020-03-27 20:39:37 +00:00
2021-11-15 21:17:43 +00:00
$ScriptInstallUpdate global-wait;
/system/scheduler/add name=bridge-port-vlan on-event="/system/script/run global-wait; :global BridgePortTo; \$BridgePortTo default;" start-time=startup;
2020-03-27 20:39:37 +00:00
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=`:
2020-03-27 20:39:37 +00:00
$BridgePortTo default;
2020-03-27 20:39:37 +00:00
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=`:
2020-03-27 20:39:37 +00:00
$BridgePortTo alt;
2020-03-27 20:39:37 +00:00
* 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:
2020-03-27 20:39:37 +00:00
$BridgePortTo extra;
2020-03-27 20:39:37 +00:00
* Interfaces `en1` and `en2` are unchanged.
* Interface `en3` is put in bridge `br-intern`.
See also
--------
2021-11-15 21:17:43 +00:00
* [Wait for global functions und modules](../global-wait.md)
* [Manage VLANs on bridge ports](bridge-port-vlan.md)
2020-03-27 20:39:37 +00:00
---
[◀ Go back to main README](../../README.md)
2020-03-27 20:39:37 +00:00
[▲ Go back to top](#top)