summaryrefslogtreecommitdiff
path: root/docs/services/udp-broadcast-relay.rst
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2020-11-30 20:53:36 +0100
committerrebortg <github@ghlr.de>2020-11-30 20:53:36 +0100
commit8943fc9f877cbee3301a8261ddd27b4b1f15f174 (patch)
treebb09c5f41a7683dc361517c2bde346eea36cda24 /docs/services/udp-broadcast-relay.rst
parente33e1268f944be445b5a771df0e97e913487512f (diff)
downloadvyos-documentation-8943fc9f877cbee3301a8261ddd27b4b1f15f174.tar.gz
vyos-documentation-8943fc9f877cbee3301a8261ddd27b4b1f15f174.zip
arrange services and protocols
Diffstat (limited to 'docs/services/udp-broadcast-relay.rst')
-rw-r--r--docs/services/udp-broadcast-relay.rst61
1 files changed, 0 insertions, 61 deletions
diff --git a/docs/services/udp-broadcast-relay.rst b/docs/services/udp-broadcast-relay.rst
deleted file mode 100644
index df48bfd6..00000000
--- a/docs/services/udp-broadcast-relay.rst
+++ /dev/null
@@ -1,61 +0,0 @@
-.. _udp_broadcast_relay:
-
-###################
-UDP Broadcast Relay
-###################
-
-Certain vendors use broadcasts to identify their equipment within one ethernet
-segment. Unfortunately if you split your network with multiple VLANs you loose
-the ability of identifying your equipment.
-
-This is where "UDP broadcast relay" comes into play! It will forward received
-broadcasts to other configured networks.
-
-Every UDP port which will be forward requires one unique ID. Currently we
-support 99 IDs!
-
-Configuration
--------------
-
-.. cfgcmd:: set service broadcast-relay id <n> description <description>
-
- A description can be added for each and every unique relay ID. This is
- useful to distinguish between multiple different ports/appliactions.
-
-.. cfgcmd:: set service broadcast-relay id <n> interface <interface>
-
- 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>
-
- The UDP port number used by your apllication. It is mandatory for this kind
- of operation.
-
-.. 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:
-
-.. cfgcmd:: set service broadcast-relay disable
-
- In addition you can also disable the whole service without the need to remove
- it from the current configuration.
-
-.. 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 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'