vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-11-02 11:52:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

igmp-proxy: document all possible commands

Browse Source
This commit is contained in:
Christian Poessinger 2019-12-20 14:44:23 +01:00
parent 678317d432
commit e3021ca833
1 changed files with 63 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
docs/routing/igmp-proxy.rst
View File

@ -1,26 +1,73 @@
.. _igmp_proxy:
##########
IGMP Proxy
==========
##########
Internet Group Management Protocol (IGMP)
:abbr:`IGMP (Internet Group Management Protocol)` proxy sends IGMP host messages
on behalf of a connected client. The configuration must define one, and only one
upstream interface, and one or more downstream interfaces.
A IGMP Proxy to send IGMP host messages on behalf of a connected client.
The configuration must define one upstream interface, and one or more downstream interfaces.
If multicast traffic originates outside the upstream subnet, the "alt-subnet" option can be used in order to define legal multicast sources.
Configuration
=============
simple example:
---------------
.. cfgcmd:: set protocols igmp-proxy interface <interface> role <upstream | downstream>
Interface eth1 LAN is behind NAT. In order to subscribe 10.0.0.0/23 subnet multicast which is in eth0 WAN we need igmp-proxy.
* **upstream:** The upstream network interface is the outgoing interface
which is responsible for communicating to available multicast data sources.
There can only be one upstream interface.
* **downstream:** Downstream network interfaces are the distribution
interfaces to the destination networks, where multicast clients can join
groups and receive multicast data. One or more downstream interfaces must
be configured.
.. cfgcmd:: set protocols igmp-proxy interface <interface> alt-subnet <network>
Defines alternate sources for multicasting and IGMP data. The network address
must be on the following format 'a.b.c.d/n'. By default the router will
accept data from sources on the same network as configured on an interface.
If the multicast source lies on a remote network, one must define from where
traffic should be accepted.
This is especially useful for the upstream interface, since the source for
multicast traffic is often from a remote location.
This option can be supplied multiple times.
.. cfgcmd:: set protocols igmp-proxy disable-quickleave
Disables quickleave mode. In this mode the daemon will not send a Leave IGMP
message upstream as soon as it receives a Leave message for any downstream
interface. The daemon will not ask for Membership reports on the downstream
interfaces, and if a report is received the group is not joined again
upstream.
If it's vital that the daemon should act exactly as a real multicast client
on the upstream interface, this function should be enabled.
Enabling this function increases the risk of bandwidth saturation.
.. cfgcmd:: set protocols igmp-proxy disable
Disable this service.
Example
-------
Interface `eth1` LAN is behind NAT. In order to subscribe `10.0.0.0/23` subnet
multicast which is in `eth0` WAN we need to configure igmp-proxy.
.. code-block:: none
# show protocols igmp-proxy
interface eth0 {
alt-subnet 10.0.0.0/23
role upstream
}
interface eth1 {
role downstream
}
set protocols igmp-proxy interface eth0 role upstream
set protocols igmp-proxy interface eth0 alt-subnet 10.0.0.0/23
set protocols igmp-proxy interface eth1 role downstream
Operation
=========
.. opcmd:: restart igmp-proxy
Restart the IGMP proxy process.