Document bridge port neighbor suppression

devel/yaml_api.md

@@ -1369,11 +1369,16 @@ The `port` subsection of `bridge` section defines a list of linux bridge ports.
 
 Each linux bridge port contains these properties:
  * `name`: Interface name.
+ * `neigh-suppress`: Boolean. Enable ARP/ND proxy and suppression on this port.
  * `stp-hairpin-mode`: Boolean.
  * `stp-path-cost`: Integer.
  * `stp-priority`: Integer.
  * `vlan`: Please check `Linux Bridge Port VLAN` section.
 
+The kernel default of `neigh-suppress` for a newly created bridge
+port is `false`. Omitting the property is not a request to disable
+it. When querying, nmstate reports the current kernel value.
+
 ### Linux Bridge Port VLAN
 
 The `vlan` subsection of `port` section of linux bridge holds the VLAN

examples.md

@@ -12,6 +12,7 @@
     * [Interfaces: VLAN](#interfaces-vlan)
     * [Interfaces: VXLAN](#interfaces-vxlan)
     * [Interface: Linux Bridge](#interface-linux-bridge)
+        * [Setting VXLAN Neighbor Suppression](#setting-vxlan-neighbor-suppression)
     * [Interfaces: Team](#interfaces-team)
     * [Interfaces: Veth](#interfaces-veth)
     * [Route](#route)
@@ -232,6 +233,51 @@ interfaces:
           stp-priority: 32
 ```
 
+### Setting VXLAN Neighbor Suppression
+
+Bridge a local VLAN to VXLAN, enabling neighbor suppression only on VXLAN.
+An external EVPN control plane handles MAC advertisements.
+
+The example assumes `eth1` is already up at `192.0.2.1` and can reach
+the remote tunnel endpoint `192.0.2.2`.
+
+```yaml
+---
+interfaces:
+  - name: br101
+    type: linux-bridge
+    state: up
+    ipv4:
+      enabled: false
+    ipv6:
+      enabled: false
+    bridge:
+      options:
+        stp:
+          enabled: false
+      port:
+        - name: eth1.101
+          neigh-suppress: false
+        - name: vxlan101
+          neigh-suppress: true
+  - name: eth1.101
+    type: vlan
+    state: up
+    vlan:
+      base-iface: eth1
+      id: 101
+  - name: vxlan101
+    type: vxlan
+    state: up
+    vxlan:
+      base-iface: eth1
+      id: 75101
+      local: 192.0.2.1
+      remote: 192.0.2.2
+      destination-port: 4789
+      learning: false
+```
+
 ## Interfaces: Team
 
 The support of Team interface is DEPRECATED by nmstate 1.x and REMOVED in 2.x.