From 0e99af7669329cace64a65ffe671fa38bbcabaf5 Mon Sep 17 00:00:00 2001 From: Maximilian Wilhelm Date: Sat, 16 Oct 2021 15:28:13 +0200 Subject: [PATCH] vxlan: Document that vxlan-phsydev is required for multicast setups Signed-off-by: Maximilian Wilhelm --- doc/interfaces-vxlan.scd | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/interfaces-vxlan.scd b/doc/interfaces-vxlan.scd index e63b00e..a6dd8b6 100644 --- a/doc/interfaces-vxlan.scd +++ b/doc/interfaces-vxlan.scd @@ -32,7 +32,8 @@ other options are optional. *vxlan-physdev* _interface_ Specifies the physical ("underlay") device to use for tunnel - endpoint communication. + endpoint communication. This is required for setups using + multicast. *vxlan-local-ip* _address_ Specifies the source IP address to use in outgoing packets. @@ -53,11 +54,11 @@ other options are optional. is an alias for this option, too. *vxlan-peer-group* _multicast group_ - Specifies the multicast group IP address to join. This parameter - cannot be specified with the _vxlan-peer-ip_ parameter. - For compatibility with ifupdown2 _vxlan-svcnodeip_ is an alias for - this option and for compatibility with previos version of ifupdown-ng - _vxlan-remote-group_ is an alias, too. + Specifies the multicast group address to join, requires _vxlan-phsydev_ + to be set as well. This parameter cannot be specified in combination + with the _vxlan-peer-ips_ parameter. For compatibility with ifupdown2 + _vxlan-svcnodeip_ is an alias for this option and for compatibility + with previos version of ifupdown-ng _vxlan-remote-group_ is an alias, too. *vxlan-learning* _on/off_ Specifies if unknown source link layer addresses and IP addresses