diff options
Diffstat (limited to 'docs/services/udp-broadcast-relay.rst')
| -rw-r--r-- | docs/services/udp-broadcast-relay.rst | 61 |
1 files changed, 35 insertions, 26 deletions
diff --git a/docs/services/udp-broadcast-relay.rst b/docs/services/udp-broadcast-relay.rst index 40f738e6..6127b79f 100644 --- a/docs/services/udp-broadcast-relay.rst +++ b/docs/services/udp-broadcast-relay.rst @@ -1,5 +1,8 @@ -UDP broadcast relay -------------------- +.. _udp_broadcast_relay: + +################### +UDP Broadcast Relay +################### Certain vendors use broadcasts to identify their equipemnt within one ethernet segment. Unfortunately if you split your network with multiple VLANs you loose @@ -11,43 +14,49 @@ broadcasts to other configured networks. Every UDP port which will be forward requires one unique ID. Currently we support 99 IDs! -Example #1: To forward all broadcast packets received on `UDP port 1900` on -`eth3`, `eth4` or `eth5` to all other interfaces in this configuration. +Configuration +------------- -.. code-block:: none +.. cfgcmd:: set service broadcast-relay id '<n>' description '<description>' - set service broadcast-relay id 1 description 'SONOS' - set service broadcast-relay id 1 interface 'eth3' - set service broadcast-relay id 1 interface 'eth4' - set service broadcast-relay id 1 interface 'eth5' - set service broadcast-relay id 1 port '1900' +A description can be added for each and every unique relay ID. This is usefull +to distinguish between multiple different ports/appliactions. -Example #2: To Forward all broadcasts packets received on `UDP port 6969` on -`eth3` or `eth4` to the other interface in this configuration. +.. cfgcmd:: set service broadcast-relay id '<n>' interface '<interface>' -.. code-block:: none +The interface used to receive and relay individual broadcast packets. If you +want to receive/relay packets on both `eth1` and `eth2` both interfaces need +to be added. + +.. cfgcmd:: set service broadcast-relay id '<n>' port '<port>' - set service broadcast-relay id 2 description 'SONOS MGMT' - set service broadcast-relay id 2 interface 'eth3' - set service broadcast-relay id 2 interface 'eth4' - set service broadcast-relay id 2 port '6969' +The UDP port number used by your apllication. It is mandatory for this kind +of operation. -Disable Instance(s) -^^^^^^^^^^^^^^^^^^^ +.. cfgcmd:: set service broadcast-relay id '<n>' disable Each broadcast relay instance can be individually disabled without deleting the configured node by using the following command: -.. code-block:: none +.. cfgcmd:: set service broadcast-relay disable - set service broadcast-relay id <n> disable +In addition you can also disable the whole service without the need to remove +it from the current configuration. -In addition you can also disable the whole service without removing the -configuration by: +.. note:: You can run the UDP broadcast relay service on multiple routers + connected to a subnet. There is **NO** UDP broadcast relay packet storm! + +Example +------- + +To forward all broadcast packets received on `UDP port 1900` on `eth3`, `eth4` +or `eth5` to all other interfaces in this configuration. .. code-block:: none - set service broadcast-relay disable + set service broadcast-relay id 1 description 'SONOS' + set service broadcast-relay id 1 interface 'eth3' + set service broadcast-relay id 1 interface 'eth4' + set service broadcast-relay id 1 interface 'eth5' + set service broadcast-relay id 1 port '1900' -.. note:: You can run the UDP broadcast relay service on multiple routers - connected to a subnet. There is **NO** UDP broadcast relay packet storm! |