Debian Codegraph @

upstream/debian-trixie/man8/bridge.8

raw
1 .TH BRIDGE 8 "1 August 2012" "iproute2" "Linux"
2 .SH NAME
3 bridge \- show / manipulate bridge addresses and devices
4 .SH SYNOPSIS
5
6 .ad l
7 .in +8
8 .ti -8
9 .B bridge
10 .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
11 .BR help " }"
12 .sp
13
14 .ti -8
15 .IR OBJECT " := { "
16 .BR link " | " fdb " | " mdb " | " vlan " | " vni " | " monitor " }"
17 .sp
18
19 .ti -8
20 .IR OPTIONS " := { "
21 \fB\-V\fR[\fIersion\fR] |
22 \fB\-s\fR[\fItatistics\fR] |
23 \fB\-n\fR[\fIetns\fR] name |
24 \fB\-b\fR[\fIatch\fR] filename |
25 \fB\-com\fR[\fIpressvlans\fR] |
26 \fB\-c\fR[\fIolor\fR] |
27 \fB\-p\fR[\fIretty\fR] |
28 \fB\-j\fR[\fIson\fR] |
29 \fB\-o\fR[\fIneline\fR] }
30
31 .ti -8
32 .B "bridge link set"
33 .B dev
34 .IR DEV " [ "
35 .B cost
36 .IR COST " ] [ "
37 .B priority
38 .IR PRIO " ] [ "
39 .B state
40 .IR STATE " ] [ "
41 .BR guard " { " on " | " off " } ] [ "
42 .BR hairpin " { " on " | " off " } ] [ "
43 .BR fastleave " { " on " | " off " } ] [ "
44 .BR root_block " { " on " | " off " } ] [ "
45 .BR learning " { " on " | " off " } ] [ "
46 .BR learning_sync " { " on " | " off " } ] [ "
47 .BR flood " { " on " | " off " } ] [ "
48 .BR hwmode " { " vepa " | " veb " } ] [ "
49 .BR bcast_flood " { " on " | " off " } ] [ "
50 .BR mcast_flood " { " on " | " off " } ] [ "
51 .BR mcast_max_groups
52 .IR MAX_GROUPS " ] ["
53 .BR mcast_router
54 .IR MULTICAST_ROUTER " ] ["
55 .BR mcast_to_unicast " { " on " | " off " } ] [ "
56 .BR neigh_suppress " { " on " | " off " } ] [ "
57 .BR neigh_vlan_suppress " { " on " | " off " } ] [ "
58 .BR vlan_tunnel " { " on " | " off " } ] [ "
59 .BR isolated " { " on " | " off " } ] [ "
60 .BR locked " { " on " | " off " } ] [ "
61 .BR mab " { " on " | " off " } ] [ "
62 .B backup_port
63 .IR DEVICE " ] ["
64 .BR nobackup_port " ] [ "
65 .B backup_nhid
66 .IR NHID " ] ["
67 .BR self " ] [ " master " ]"
68
69 .ti -8
70 .BR "bridge link" " [ " show " ] [ "
71 .B dev
72 .IR DEV " ] ["
73 .B master
74 .IR DEVICE " ]"
75
76 .ti -8
77 .BR "bridge fdb" " { " add " | " append " | " del " | " replace " } "
78 .I LLADDR
79 .B dev
80 .IR DEV " { "
81 .BR local " | " static " | " dynamic " } [ "
82 .BR self " ] [ " master " ] [ " router " ] [ " use " ] [ " extern_learn " ] [ " sticky " ] [ "
83 .B src_vni
84 .IR VNI " ] { ["
85 .B dst
86 .IR IPADDR " ] [ "
87 .B vni
88 .IR VNI " ] ["
89 .B port
90 .IR PORT " ] ["
91 .B via
92 .IR DEVICE " ] | "
93 .B nhid
94 .IR NHID " } "
95
96 .ti -8
97 .BR "bridge fdb" " [ [ " show " ] [ "
98 .B br
99 .IR BRDEV " ] [ "
100 .B brport
101 .IR DEV " ] [ "
102 .B vlan
103 .IR VID " ] [ "
104 .B state
105 .IR STATE " ] ["
106 .B dynamic
107 .IR "] ]"
108
109 .ti -8
110 .BR "bridge fdb get" " ["
111 .B to
112 .IR "]"
113 .I LLADDR "[ "
114 .B br
115 .IR BRDEV " ]"
116 .B { brport | dev }
117 .IR DEV " [ "
118 .B vlan
119 .IR VID " ] [ "
120 .B vni
121 .IR VNI " ] ["
122 .BR self " ] [ " master " ] [ " dynamic " ]"
123
124 .ti -8
125 .BR "bridge fdb flush"
126 .B dev
127 .IR DEV " [ "
128 .B brport
129 .IR DEV " ] [ "
130 .B vlan
131 .IR VID " ] [ "
132 .B src_vni
133 .IR VNI " ] [ "
134 .B nhid
135 .IR NHID " ] ["
136 .B vni
137 .IR VNI " ] [ "
138 .B port
139 .IR PORT " ] ["
140 .B dst
141 .IR IPADDR " ] [ "
142 .BR self " ] [ " master " ] [ "
143 .BR [no]permanent " | " [no]static " | " [no]dynamic " ] [ "
144 .BR [no]added_by_user " ] [ " [no]extern_learn " ] [ "
145 .BR [no]sticky " ] [ " [no]offloaded " ] [ " [no]router " ]"
146
147 .ti -8
148 .BR "bridge mdb" " { " add " | " del " | " replace " } "
149 .B dev
150 .I DEV
151 .B port
152 .I PORT
153 .B grp
154 .IR GROUP " [ "
155 .B src
156 .IR SOURCE " ] [ "
157 .BR permanent " | " temp " ] [ "
158 .B vid
159 .IR VID " ] [ "
160 .BR filter_mode " { " include " | " exclude " } ] [ "
161 .B source_list
162 .IR SOURCE_LIST " ] [ "
163 .B proto
164 .IR PROTO " ] [ "
165 .B dst
166 .IR IPADDR " ] [ "
167 .B dst_port
168 .IR DST_PORT " ] [ "
169 .B vni
170 .IR VNI " ] [ "
171 .B src_vni
172 .IR SRC_VNI " ] [ "
173 .B via
174 .IR DEV " ]
175
176 .ti -8
177 .BR "bridge mdb show" " [ "
178 .B dev
179 .IR DEV " ]"
180
181 .ti -8
182 .B "bridge mdb get"
183 .BI dev " DEV " grp " GROUP "
184 .RB "[ " src
185 .IR SOURCE " ]"
186 .RB "[ " vid
187 .IR VID " ]"
188 .RB "[ " src_vni
189 .IR SRC_VNI " ]"
190
191 .ti -8
192 .B "bridge mdb flush"
193 .BI dev " DEV "
194 .RB "[ " port
195 .IR PORT " ]"
196 .RB "[ " vid
197 .IR VID " ]"
198 .RB "[ " src_vni
199 .IR SRC_VNI " ]"
200 .RB "[ " proto
201 .IR PROTO " ]"
202 .RB "[ " [no]permanent " ]"
203 .RB "[ " dst
204 .IR IPADDR " ]"
205 .RB "[ " dst_port
206 .IR DST_PORT " ]"
207 .RB "[ " vni
208 .IR VNI " ]"
209
210 .ti -8
211 .B "bridge mst set"
212 .IR dev " DEV " msti " MSTI " state " STP_STATE "
213
214 .ti -8
215 .BR "bridge mst" " [ [ " show " ] [ "
216 .B dev
217 .IR DEV " ] ]"
218
219 .ti -8
220 .BR "bridge vlan" " { " add " | " del " } "
221 .B dev
222 .I DEV
223 .B vid
224 .IR VID " [ "
225 .B tunnel_info
226 .IR TUNNEL_ID " ] [ "
227 .BR pvid " ] [ " untagged " ] [ "
228 .BR self " ] [ " master " ] "
229
230 .ti -8
231 .BR "bridge vlan set"
232 .B dev
233 .I DEV
234 .B vid
235 .IR VID " [ "
236 .B state
237 .IR STP_STATE " ] [ "
238 .B mcast_max_groups
239 .IR MAX_GROUPS " ] [ "
240 .B mcast_router
241 .IR MULTICAST_ROUTER " ] [ "
242 .BR neigh_suppress " { " on " | " off " } ]"
243
244 .ti -8
245 .BR "bridge vlan" " [ " show " | " tunnelshow " ] [ "
246 .B dev
247 .IR DEV " ]"
248
249 .ti -8
250 .BR "bridge vlan global set"
251 .B dev
252 .I DEV
253 .B vid
254 .IR VID " [ "
255 .B mcast_snooping
256 .IR MULTICAST_SNOOPING " ] [ "
257 .B mcast_querier
258 .IR MULTICAST_QUERIER " ] [ "
259 .B mcast_igmp_version
260 .IR IGMP_VERSION " ] [ "
261 .B mcast_mld_version
262 .IR MLD_VERSION " ] [ "
263 .B mcast_last_member_count
264 .IR LAST_MEMBER_COUNT " ] [ "
265 .B mcast_last_member_interval
266 .IR LAST_MEMBER_INTERVAL " ] [ "
267 .B mcast_startup_query_count
268 .IR STARTUP_QUERY_COUNT " ] [ "
269 .B mcast_startup_query_interval
270 .IR STARTUP_QUERY_INTERVAL " ] [ "
271 .B mcast_membership_interval
272 .IR MEMBERSHIP_INTERVAL " ] [ "
273 .B mcast_querier_interval
274 .IR QUERIER_INTERVAL " ] [ "
275 .B mcast_query_interval
276 .IR QUERY_INTERVAL " ] [ "
277 .B mcast_query_response_interval
278 .IR QUERY_RESPONSE_INTERVAL " ] [ "
279 .B msti
280 .IR MSTI " ]"
281
282 .ti -8
283 .BR "bridge vlan global" " [ " show " ] [ "
284 .B dev
285 .IR DEV " ] [ "
286 .B vid
287 .IR VID " ]"
288
289 .ti -8
290 .BR "bridge vlan" " show " [ "
291 .B dev
292 .IR DEV " ]"
293
294 .ti -8
295 .BR "bridge vni" " { " add " | " del " } "
296 .B dev
297 .I DEV
298 .B vni
299 .IR VNI " [ { "
300 .B group | remote "} "
301 .IR IPADDR " ] "
302
303 .ti -8
304 .BR "bridge vni" " show " [ "
305 .B dev
306 .IR DEV " ]"
307
308 .ti -8
309 .BR "bridge monitor" " [ " all " | " neigh " | " link " | " mdb " | " vlan " ]"
310
311 .SH OPTIONS
312
313 .TP
314 .BR "\-V" , " -Version"
315 print the version of the
316 .B bridge
317 utility and exit.
318
319 .TP
320 .BR "\-s" , " \-stats", " \-statistics"
321 output more information. If this option
322 is given multiple times, the amount of information increases.
323 As a rule, the information is statistics or some time values.
324
325 .TP
326 .BR "\-d" , " \-details"
327 print detailed information about bridge vlan filter entries or MDB router ports.
328
329 .TP
330 .BR "\-n" , " \-net" , " \-netns " <NETNS>
331 switches
332 .B bridge
333 to the specified network namespace
334 .IR NETNS .
335 Actually it just simplifies executing of:
336
337 .B ip netns exec
338 .I NETNS
339 .B bridge
340 .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
341 .BR help " }"
342
343 to
344
345 .B bridge
346 .RI "-n[etns] " NETNS " [ " OPTIONS " ] " OBJECT " { " COMMAND " | "
347 .BR help " }"
348
349 .TP
350 .BR "\-b", " \-batch " <FILENAME>
351 Read commands from provided file or standard input and invoke them.
352 First failure will cause termination of bridge command.
353
354 .TP
355 .B "\-force"
356 Don't terminate bridge command on errors in batch mode.
357 If there were any errors during execution of the commands, the application
358 return code will be non zero.
359
360 .TP
361 .BR "\-com", " \-compressvlans"
362 Show compressed VLAN list. It will show continuous VLANs with the range instead
363 of separated VLANs. Default is off.
364
365 .TP
366 .BR \-c [ color ][ = { always | auto | never }
367 Configure color output. If parameter is omitted or
368 .BR always ,
369 color output is enabled regardless of stdout state. If parameter is
370 .BR auto ,
371 stdout is checked to be a terminal before enabling color output. If parameter is
372 .BR never ,
373 color output is disabled. If specified multiple times, the last one takes
374 precedence. This flag is ignored if
375 .B \-json
376 is also given.
377
378 .TP
379 .BR "\-j", " \-json"
380 Output results in JavaScript Object Notation (JSON).
381
382 .TP
383 .BR "\-p", " \-pretty"
384 When combined with -j generate a pretty JSON output.
385
386 .TP
387 .BR "\-o", " \-oneline"
388 output each record on a single line, replacing line feeds
389 with the
390 .B '\e'
391 character. This is convenient when you want to count records
392 with
393 .BR wc (1)
394 or to
395 .BR grep (1)
396 the output.
397
398
399 .SH BRIDGE - COMMAND SYNTAX
400
401 .SS
402 .I OBJECT
403
404 .TP
405 .B link
406 - Bridge port.
407
408 .TP
409 .B fdb
410 - Forwarding Database entry.
411
412 .TP
413 .B mdb
414 - Multicast group database entry.
415
416 .TP
417 .B vlan
418 - VLAN filter list.
419
420 .TP
421 .B vni
422 - VNI filter list.
423
424 .SS
425 .I COMMAND
426
427 Specifies the action to perform on the object.
428 The set of possible actions depends on the object type.
429 As a rule, it is possible to
430 .BR "add" , " delete"
431 and
432 .B show
433 (or
434 .B list
435 ) objects, but some objects do not allow all of these operations
436 or have some additional commands. The
437 .B help
438 command is available for all objects. It prints
439 out a list of available commands and argument syntax conventions.
440 .sp
441 If no command is given, some default command is assumed.
442 Usually it is
443 .B list
444 or, if the objects of this class cannot be listed,
445 .BR "help" .
446
447 .SH bridge link - bridge port
448
449 .B link
450 objects correspond to the port devices of the bridge.
451
452 .P
453 The corresponding commands set and display port status and bridge specific
454 attributes.
455
456 .SS bridge link set - set bridge specific attributes on a port
457
458 .TP
459 .BI dev " NAME "
460 interface name of the bridge port
461
462 .TP
463 .BI cost " COST "
464 the STP path cost of the specified port.
465
466 .TP
467 .BI priority " PRIO "
468 the STP port priority. The priority value is an unsigned 8-bit quantity
469 (number between 0 and 255). This metric is used in the designated port an
470 droot port selection algorithms.
471
472 .TP
473 .BI state " STATE "
474 the operation state of the port. Except state 0 (disable STP or BPDU filter feature),
475 this is primarily used by user space STP/RSTP
476 implementation. One may enter port state name (case insensitive), or one of the
477 numbers below. Negative inputs are ignored, and unrecognized names return an
478 error.
479
480 .B 0
481 - port is in STP
482 .B DISABLED
483 state. Make this port completely inactive for STP. This is also called
484 BPDU filter and could be used to disable STP on an untrusted port, like
485 a leaf virtual devices.
486 .sp
487
488 .B 1
489 - port is in STP
490 .B LISTENING
491 state. Only valid if STP is enabled on the bridge. In this
492 state the port listens for STP BPDUs and drops all other traffic frames.
493 .sp
494
495 .B 2
496 - port is in STP
497 .B LEARNING
498 state. Only valid if STP is enabled on the bridge. In this
499 state the port will accept traffic only for the purpose of updating MAC
500 address tables.
501 .sp
502
503 .B 3
504 - port is in STP
505 .B FORWARDING
506 state. Port is fully active.
507 .sp
508
509 .B 4
510 - port is in STP
511 .B BLOCKING
512 state. Only valid if STP is enabled on the bridge. This state
513 is used during the STP election process. In this state, port will only process
514 STP BPDUs.
515 .sp
516
517 .TP
518 .BR "guard on " or " guard off "
519 Controls whether STP BPDUs will be processed by the bridge port. By default,
520 the flag is turned off allowed BPDU processing. Turning this flag on will
521 disables
522 the bridge port if a STP BPDU packet is received.
523
524 If running Spanning Tree on bridge, hostile devices on the network
525 may send BPDU on a port and cause network failure. Setting
526 .B guard on
527 will detect and stop this by disabling the port.
528 The port will be restarted if link is brought down, or
529 removed and reattached. For example if guard is enable on
530 eth0:
531
532 .B ip link set dev eth0 down; ip link set dev eth0 up
533
534 .TP
535 .BR "hairpin on " or " hairpin off "
536 Controls whether traffic may be send back out of the port on which it was
537 received. This option is also called reflective relay mode, and is used to support
538 basic VEPA (Virtual Ethernet Port Aggregator) capabilities.
539 By default, this flag is turned off and the bridge will not forward
540 traffic back out of the receiving port.
541
542 .TP
543 .BR "fastleave on " or " fastleave off "
544 This flag allows the bridge to immediately stop multicast traffic on a port
545 that receives IGMP Leave message. It is only used with IGMP snooping is
546 enabled on the bridge. By default the flag is off.
547
548 .TP
549 .BR "root_block on " or " root_block off "
550 Controls whether a given port is allowed to become root port or not. Only used
551 when STP is enabled on the bridge. By default the flag is off.
552
553 This feature is also called root port guard.
554 If BPDU is received from a leaf (edge) port, it should not
555 be elected as root port. This could be used if using STP on a bridge and the downstream bridges are not fully
556 trusted; this prevents a hostile guest from rerouting traffic.
557
558 .TP
559 .BR "learning on " or " learning off "
560 Controls whether a given port will learn MAC addresses from received traffic or
561 not. If learning if off, the bridge will end up flooding any traffic for which
562 it has no FDB entry. By default this flag is on.
563
564 .TP
565 .BR "learning_sync on " or " learning_sync off "
566 Controls whether a given port will sync MAC addresses learned on device port to
567 bridge FDB.
568
569 .TP
570 .BR "flood on " or " flood off "
571 Controls whether unicast traffic for which there is no FDB entry will be
572 flooded towards this given port. By default this flag is on.
573
574 .TP
575 .B hwmode
576 Some network interface cards support HW bridge functionality and they may be
577 configured in different modes. Currently support modes are:
578
579 .B vepa
580 - Data sent between HW ports is sent on the wire to the external
581 switch.
582
583 .B veb
584 - bridging happens in hardware.
585
586 .TP
587 .BR "bcast_flood on " or " bcast_flood off "
588 Controls flooding of broadcast traffic on the given port.
589 By default this flag is on.
590
591 .TP
592 .BR "mcast_flood on " or " mcast_flood off "
593 Controls whether multicast traffic for which there is no MDB entry will be
594 flooded towards this given port. By default this flag is on.
595
596 .TP
597 .BI mcast_max_groups " MAX_GROUPS "
598 Sets the maximum number of MDB entries that can be registered for a given
599 port. Attempts to register more MDB entries at the port than this limit
600 allows will be rejected, whether they are done through netlink (e.g. the
601 \fBbridge\fR tool), or IGMP or MLD membership reports. Setting a limit to 0
602 has the effect of disabling the limit. The default value is 0. See also the
603 \fBip link\fR option \fBmcast_hash_max\fR.
604
605 .TP
606 .BI mcast_router " MULTICAST_ROUTER "
607 This flag is almost the same as the per-VLAN flag, see below, except its
608 value can only be set in the range 0-2. The default is
609 .B 1
610 where the bridge figures out automatically where an IGMP/MLD querier,
611 MRDISC capable device, or PIM router, is located. Setting this flag to
612 .B 2
613 is useful in cases where the multicast router does not indicate its
614 presence in any meaningful way (e.g. older versions of SMCRoute, or
615 mrouted), or when there is a need for forwarding both known and unknown
616 IP multicast to a secondary/backup router.
617
618 .TP
619 .BR "mcast_to_unicast on " or " mcast_to_unicast off "
620 Controls whether a given port will replicate packets using unicast
621 instead of multicast. By default this flag is off.
622
623 This is done by copying the packet per host and
624 changing the multicast destination MAC to a unicast one accordingly.
625
626 .B mcast_to_unicast
627 works on top of the multicast snooping feature of
628 the bridge. Which means unicast copies are only delivered to hosts which
629 are interested in it and signalized this via IGMP/MLD reports
630 previously.
631
632 This feature is intended for interface types which have a more reliable
633 and/or efficient way to deliver unicast packets than broadcast ones
634 (e.g. WiFi).
635
636 However, it should only be enabled on interfaces where no IGMPv2/MLDv1
637 report suppression takes place. IGMP/MLD report suppression issue is usually
638 overcome by the network daemon (supplicant) enabling AP isolation and
639 by that separating all STAs.
640
641 Delivery of STA-to-STA IP multicast is made possible again by
642 enabling and utilizing the bridge hairpin mode, which considers the
643 incoming port as a potential outgoing port, too (see
644 .B hairpin
645 option).
646 Hairpin mode is performed after multicast snooping, therefore leading to
647 only deliver reports to STAs running a multicast router.
648
649 .TP
650 .BR "neigh_suppress on " or " neigh_suppress off "
651 Controls whether neigh discovery (arp and nd) proxy and suppression is
652 enabled on the port. By default this flag is off.
653
654 .TP
655 .BR "neigh_vlan_suppress on " or " neigh_vlan_suppress off "
656 Controls whether per-VLAN neigh discovery (arp and nd) proxy and suppression is
657 enabled on the port. When on, the \fBbridge link\fR option \fBneigh_suppress\fR
658 has no effect and the per-VLAN state is set using the \fBbridge vlan\fR option
659 \fBneigh_suppress\fR. By default this flag is off.
660
661 .TP
662 .BR "vlan_tunnel on " or " vlan_tunnel off "
663 Controls whether vlan to tunnel mapping is enabled on the port. By
664 default this flag is off.
665
666 .TP
667 .BR "isolated on " or " isolated off "
668 Controls whether a given port will be isolated, which means it will be
669 able to communicate with non-isolated ports only. By default this
670 flag is off.
671
672 .TP
673 .BR "locked on " or " locked off "
674 Controls whether a port is locked or not. When locked, non-link-local frames
675 received through the port are dropped unless an FDB entry with the MAC source
676 address points to the port. The common use case is IEEE 802.1X where hosts can
677 authenticate themselves by exchanging EAPOL frames with an authenticator. After
678 authentication is complete, the user space control plane can install a matching
679 FDB entry to allow traffic from the host to be forwarded by the bridge. When
680 learning is enabled on a locked port, the
681 .B no_linklocal_learn
682 bridge option needs to be on to prevent the bridge from learning from received
683 EAPOL frames. By default this flag is off.
684
685 .TP
686 .BR "mab on " or " mab off "
687 Controls whether MAC Authentication Bypass (MAB) is enabled on the port or not.
688 MAB can only be enabled on a locked port that has learning enabled. When
689 enabled, FDB entries are learned from received traffic and have the "locked"
690 FDB flag set. The flag can only be set by the kernel and it indicates that the
691 FDB entry cannot be used to authenticate the corresponding host. User space can
692 decide to authenticate the host by replacing the FDB entry and clearing the
693 "locked" FDB flag. Locked FDB entries can roam to unlocked (authorized) ports
694 in which case the "locked" flag is cleared. FDB entries cannot roam to locked
695 ports regardless of MAB being enabled or not. Therefore, locked FDB entries are
696 only created if an FDB entry with the given {MAC, VID} does not already exist.
697 This behavior prevents unauthenticated hosts from disrupting traffic destined
698 to already authenticated hosts. Locked FDB entries act like regular dynamic
699 entries with respect to forwarding and aging. By default this flag is off.
700
701 .TP
702 .BI backup_port " DEVICE"
703 If the port loses carrier all traffic will be redirected to the
704 configured backup port
705
706 .TP
707 .B nobackup_port
708 Removes the currently configured backup port
709
710 .TP
711 .BI backup_nhid " NHID"
712 The FDB nexthop object ID (see \fBip-nexthop\fR(8)) to attach to packets being
713 redirected to a backup port that has VLAN tunnel mapping enabled (via the
714 \fBvlan_tunnel\fR option). Setting a value of 0 (default) has the effect of not
715 attaching any ID.
716
717 .TP
718 .B self
719 link setting is configured on specified physical device
720
721 .TP
722 .B master
723 link setting is configured on the software bridge (default)
724
725 .TP
726 .BR "\-t" , " \-timestamp"
727 display current time when using monitor option.
728
729 .SS bridge link show - list ports configuration for all bridges.
730
731 This command displays ports configuration and flags for all bridges by default.
732
733 .TP
734 .BI dev " DEV"
735 only display the specific bridge port named DEV.
736
737 .TP
738 .BI master " DEVICE"
739 only display ports of the bridge named DEVICE. This is similar to
740 "ip link show master <bridge_device>" command.
741
742 .SH bridge fdb - forwarding database management
743
744 .B fdb
745 objects contain known Ethernet addresses on a link.
746
747 .P
748 The corresponding commands display fdb entries, add new entries,
749 append entries,
750 and delete old ones.
751
752 .SS bridge fdb add - add a new fdb entry
753
754 This command creates a new fdb entry.
755
756 .TP
757 .B LLADDR
758 the Ethernet MAC address.
759
760 .TP
761 .BI dev " DEV"
762 the interface to which this address is associated.
763
764 .B local
765 - is a local permanent fdb entry, which means that the bridge will not forward
766 frames with this destination MAC address and VLAN ID, but terminate them
767 locally. This flag is default unless "static" or "dynamic" are explicitly
768 specified.
769 .sp
770
771 .B permanent
772 - this is a synonym for "local"
773 .sp
774
775 .B static
776 - is a static (no arp) fdb entry
777 .sp
778
779 .B dynamic
780 - is a dynamic reachable age-able fdb entry
781 .sp
782
783 .B self
784 - the operation is fulfilled directly by the driver for the specified network
785 device. If the network device belongs to a master like a bridge, then the
786 bridge is bypassed and not notified of this operation (and if the device does
787 notify the bridge, it is driver-specific behavior and not mandated by this
788 flag, check the driver for more details). The "bridge fdb add" command can also
789 be used on the bridge device itself, and in this case, the added fdb entries
790 will be locally terminated (not forwarded). In the latter case, the "self" flag
791 is mandatory. The flag is set by default if "master" is not specified.
792 .sp
793
794 .B master
795 - if the specified network device is a port that belongs to a master device
796 such as a bridge, the operation is fulfilled by the master device's driver,
797 which may in turn notify the port driver too of the address. If the specified
798 device is a master itself, such as a bridge, this flag is invalid.
799 .sp
800
801 .B router
802 - the destination address is associated with a router.
803 Valid if the referenced device is a VXLAN type device and has
804 route short circuit enabled.
805 .sp
806
807 .B use
808 - the address is in use. User space can use this option to
809 indicate to the kernel that the fdb entry is in use.
810 .sp
811
812 .B extern_learn
813 - this entry was learned externally. This option can be used to
814 indicate to the kernel that an entry was hardware or user-space
815 controller learnt dynamic entry. Kernel will not age such an entry.
816 .sp
817
818 .B sticky
819 - this entry will not change its port due to learning.
820 .sp
821
822 .in -8
823 The next command line parameters apply only
824 when the specified device
825 .I DEV
826 is of type VXLAN.
827 .TP
828 .BI dst " IPADDR"
829 the IP address of the destination
830 VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
831
832 .TP
833 .BI src_vni " VNI"
834 the src VNI Network Identifier (or VXLAN Segment ID)
835 this entry belongs to. Used only when the vxlan device is in
836 external or collect metadata mode. If omitted the value specified at
837 vxlan device creation will be used.
838
839 .TP
840 .BI vni " VNI"
841 the VXLAN VNI Network Identifier (or VXLAN Segment ID)
842 to use to connect to the remote VXLAN tunnel endpoint.
843 If omitted the value specified at vxlan device creation
844 will be used.
845
846 .TP
847 .BI port " PORT"
848 the UDP destination PORT number to use to connect to the
849 remote VXLAN tunnel endpoint.
850 If omitted the default value is used.
851
852 .TP
853 .BI via " DEVICE"
854 device name of the outgoing interface for the
855 VXLAN device driver to reach the
856 remote VXLAN tunnel endpoint.
857
858 .TP
859 .BI nhid " NHID "
860 ecmp nexthop group for the VXLAN device driver
861 to reach remote VXLAN tunnel endpoints.
862
863 .SS bridge fdb append - append a forwarding database entry
864 This command adds a new fdb entry with an already known
865 .IR LLADDR .
866 Valid only for multicast link layer addresses.
867 The command adds support for broadcast and multicast
868 Ethernet MAC addresses.
869 The Ethernet MAC address is added multiple times into
870 the forwarding database and the vxlan device driver
871 sends a copy of the data packet to each entry found.
872
873 .PP
874 The arguments are the same as with
875 .BR "bridge fdb add" .
876
877 .SS bridge fdb delete - delete a forwarding database entry
878 This command removes an existing fdb entry.
879
880 .PP
881 The arguments are the same as with
882 .BR "bridge fdb add" .
883
884 .SS bridge fdb replace - replace a forwarding database entry
885 If no matching entry is found, a new one will be created instead.
886
887 .PP
888 The arguments are the same as with
889 .BR "bridge fdb add" .
890
891 .SS bridge fdb show - list forwarding entries.
892
893 This command displays the current forwarding table.
894
895 .PP
896 With the
897 .B -statistics
898 option, the command becomes verbose. It prints out the last updated
899 and last used time for each entry.
900
901 .SS bridge fdb get - get bridge forwarding entry.
902
903 lookup a bridge forwarding table entry.
904
905 .TP
906 .B LLADDR
907 the Ethernet MAC address.
908
909 .TP
910 .BI dev " DEV"
911 the interface to which this address is associated.
912
913 .TP
914 .BI brport " DEV"
915 the bridge port to which this address is associated. same as dev above.
916
917 .TP
918 .BI br " DEV"
919 the bridge to which this address is associated.
920
921 .TP
922 .B self
923 - the address is associated with the port drivers fdb. Usually hardware.
924
925 .TP
926 .B master
927 - the address is associated with master devices fdb. Usually software (default).
928
929 .SS bridge fdb flush - flush bridge forwarding table entries.
930
931 flush the matching bridge forwarding table entries. Some options below have a negated
932 form when "no" is prepended to them (e.g. permanent and nopermanent).
933
934 .TP
935 .BI dev " DEV"
936 the target device for the operation. If the device is a bridge port and "master"
937 is set then the operation will be fulfilled by its master device's driver and
938 all entries pointing to that port will be deleted.
939
940 .TP
941 .BI brport " DEV"
942 the target bridge port for the operation. If the bridge device is specified then only
943 entries pointing to the bridge itself will be deleted. Note that the target device
944 specified by this option will override the one specified by dev above.
945
946 .TP
947 .BI vlan " VID"
948 the target VLAN ID for the operation. Match forwarding table entries only with the
949 specified VLAN ID.
950
951 .TP
952 .BI src_vni " VNI"
953 the src VNI Network Identifier (or VXLAN Segment ID) for the operation. Match
954 forwarding table entries only with the specified VNI. Valid if the referenced
955 device is a VXLAN type device.
956
957 .TP
958 .BI nhid " NHID"
959 the ECMP nexthop group for the operation. Match forwarding table entries only
960 with the specified NHID. Valid if the referenced device is a VXLAN type device.
961
962 .TP
963 .BI vni " VNI"
964 the VXLAN VNI Network Identifier (or VXLAN Segment ID) for the operation. Match
965 forwarding table entries only with the specified VNI. Valid if the referenced
966 device is a VXLAN type device.
967
968 .TP
969 .BI port " PORT"
970 the UDP destination PORT number for the operation. Match forwarding table
971 entries only with the specified PORT. Valid if the referenced device is a VXLAN
972 type device.
973
974 .TP
975 .BI dst " IPADDR"
976 the IP address of the destination VXLAN tunnel endpoint for the operation. Match
977 forwarding table entries only with the specified IPADDR. Valid if the referenced
978 device is a VXLAN type device.
979
980 .TP
981 .B self
982 the operation is fulfilled directly by the driver for the specified network
983 device. If the network device belongs to a master like a bridge, then the
984 bridge is bypassed and not notified of this operation. The "bridge fdb flush"
985 command can also be used on the bridge device itself. The flag is set by default if
986 "master" is not specified.
987
988 .TP
989 .B master
990 if the specified network device is a port that belongs to a master device
991 such as a bridge, the operation is fulfilled by the master device's driver.
992 Flush with both 'master' and 'self' is not recommended with attributes that are
993 not supported by all devices (e.g., vlan, vni). Such command will be handled by
994 bridge or VXLAN driver, but will return an error from the driver that does not
995 support the attribute. Instead, run flush twice - once with 'self' and once
996 with 'master', and each one with the supported attributes.
997
998 .TP
999 .B [no]permanent
1000 if specified then only permanent entries will be deleted or respectively if "no"
1001 is prepended then only non-permanent entries will be deleted.
1002
1003 .TP
1004 .B [no]static
1005 if specified then only static entries will be deleted or respectively if "no"
1006 is prepended then only non-static entries will be deleted.
1007
1008 .TP
1009 .B [no]dynamic
1010 if specified then only dynamic entries will be deleted or respectively if "no"
1011 is prepended then only non-dynamic (static or permanent) entries will be deleted.
1012
1013 .TP
1014 .B [no]added_by_user
1015 if specified then only entries with added_by_user flag will be deleted or respectively
1016 if "no" is prepended then only entries without added_by_user flag will be deleted.
1017
1018 .TP
1019 .B [no]extern_learn
1020 if specified then only entries with extern_learn flag will be deleted or respectively
1021 if "no" is prepended then only entries without extern_learn flag will be deleted.
1022
1023 .TP
1024 .B [no]sticky
1025 if specified then only entries with sticky flag will be deleted or respectively
1026 if "no" is prepended then only entries without sticky flag will be deleted.
1027
1028 .TP
1029 .B [no]offloaded
1030 if specified then only entries with offloaded flag will be deleted or respectively
1031 if "no" is prepended then only entries without offloaded flag will be deleted.
1032 .sp
1033
1034 .TP
1035 .B [no]router
1036 if specified then only entries with router flag will be deleted or respectively
1037 if "no" is prepended then only entries without router flag will be deleted. Valid
1038 if the referenced device is a VXLAN type device.
1039 .sp
1040
1041 .SH bridge mdb - multicast group database management
1042
1043 .B mdb
1044 objects contain known IP or L2 multicast group addresses on a link.
1045
1046 .P
1047 The corresponding commands display mdb entries, add new entries, replace
1048 entries and delete old ones.
1049
1050 .SS bridge mdb add - add a new multicast group database entry
1051
1052 This command creates a new mdb entry.
1053
1054 .TP
1055 .BI dev " DEV"
1056 the interface where this group address is associated.
1057
1058 .TP
1059 .BI port " PORT"
1060 the port whose link is known to have members of this multicast group.
1061
1062 .TP
1063 .BI grp " GROUP"
1064 the multicast group address (IPv4, IPv6 or L2 multicast) whose members reside
1065 on the link connected to the port.
1066
1067 .B permanent
1068 - the mdb entry is permanent. Optional for IPv4 and IPv6, mandatory for L2.
1069 .sp
1070
1071 .B temp
1072 - the mdb entry is temporary (default)
1073 .sp
1074
1075 .TP
1076 .BI src " SOURCE"
1077 optional source IP address of a sender for this multicast group. If IGMPv3 for IPv4, or
1078 MLDv2 for IPv6 respectively, are enabled it will be included in the lookup when
1079 forwarding multicast traffic.
1080
1081 .TP
1082 .BI vid " VID"
1083 the VLAN ID which is known to have members of this multicast group.
1084
1085 .TP
1086 .BR "filter_mode include " or " filter_mode exclude "
1087 controls whether the sources in the entry's source list are in INCLUDE or
1088 EXCLUDE mode. Can only be set for (*, G) entries.
1089
1090 .TP
1091 .BI source_list " SOURCE_LIST"
1092 optional list of source IP addresses of senders for this multicast group,
1093 separated by a ','. Whether the entry forwards packets from these senders or
1094 not is determined by the entry's filter mode, which becomes a mandatory
1095 argument. Can only be set for (*, G) entries.
1096
1097 .TP
1098 .BI proto " PROTO"
1099 the routing protocol identifier of this mdb entry. Can be a number or a string
1100 from the file /etc/iproute2/rt_protos. If the routing protocol is not given,
1101 then
1102 .B static
1103 is assumed.
1104
1105 .in -8
1106 The next command line parameters apply only
1107 when the specified device
1108 .I DEV
1109 is of type VXLAN.
1110
1111 .TP
1112 .BI dst " IPADDR"
1113 the IP address of the destination
1114 VXLAN tunnel endpoint where the multicast receivers reside.
1115
1116 .TP
1117 .BI dst_port " DST_PORT"
1118 the UDP destination port number to use to connect to the remote VXLAN tunnel
1119 endpoint. If omitted, the value specified at VXLAN device creation will be
1120 used.
1121
1122 .TP
1123 .BI vni " VNI"
1124 the VXLAN VNI Network Identifier to use to connect to the remote VXLAN tunnel
1125 endpoint. If omitted, the value specified at VXLAN device creation will be used
1126 or the source VNI when the VXLAN device is in external mode.
1127
1128 .TP
1129 .BI src_vni " SRC_VNI"
1130 the source VNI Network Identifier this entry belongs to. Used only when the
1131 VXLAN device is in external mode. If omitted, the value specified at VXLAN
1132 device creation will be used.
1133
1134 .TP
1135 .BI via " DEV"
1136 device name of the outgoing interface for the VXLAN device to reach the remote
1137 VXLAN tunnel endpoint.
1138
1139 .in -8
1140 The 0.0.0.0 and :: MDB entries are special catchall entries used to flood IPv4
1141 and IPv6 unregistered multicast packets, respectively. Therefore, when these
1142 entries are programmed, the catchall 00:00:00:00:00:00 FDB entry will only
1143 flood broadcast, unknown unicast and link-local multicast.
1144
1145 .in -8
1146 .SS bridge mdb delete - delete a multicast group database entry
1147 This command removes an existing mdb entry.
1148
1149 .PP
1150 The arguments are the same as with
1151 .BR "bridge mdb add" .
1152
1153 .SS bridge mdb replace - replace a multicast group database entry
1154 If no matching entry is found, a new one will be created instead.
1155
1156 .PP
1157 The arguments are the same as with
1158 .BR "bridge mdb add" .
1159
1160 .SS bridge mdb show - list multicast group database entries
1161
1162 This command displays the current multicast group membership table. The table
1163 is populated by IGMP and MLD snooping in the bridge driver automatically. It
1164 can be altered by
1165 .B bridge mdb add
1166 and
1167 .B bridge mdb del
1168 commands manually too.
1169
1170 .TP
1171 .BI dev " DEV"
1172 the interface only whose entries should be listed. Default is to list all
1173 bridge interfaces.
1174
1175 .PP
1176 With the
1177 .B -details
1178 option, the command becomes verbose. It prints out the ports known to have
1179 a connected router.
1180
1181 .PP
1182 With the
1183 .B -statistics
1184 option, the command displays timer values for mdb and router port entries.
1185
1186 .SS bridge mdb get - get multicast group database entry.
1187
1188 This command retrieves a multicast group database entry based on its key.
1189
1190 .TP
1191 .BI dev " DEV"
1192 the interface where this group address is associated.
1193
1194 .TP
1195 .BI grp " GROUP"
1196 the multicast group address (IPv4, IPv6 or L2 multicast).
1197
1198 .TP
1199 .BI src " SOURCE"
1200 the source IP address. Only relevant when retrieving an (S, G) entry.
1201
1202 .TP
1203 .BI vid " VID"
1204 the VLAN ID. Only relevant when the bridge is VLAN-aware.
1205
1206 .TP
1207 .BI src_vni " SRC_VNI"
1208 the source VNI Network Identifier. Only relevant when the VXLAN device is in
1209 external mode.
1210
1211 .SS bridge mdb flush - flush multicast group database entries.
1212
1213 This command flushes the matching multicast group database entries.
1214
1215 .TP
1216 .BI dev " DEV"
1217 the interface where this group address is associated.
1218
1219 .TP
1220 .BI port " PORT"
1221 the target port for the operation. If the bridge device is specified then only
1222 entries pointing to the bridge itself will be deleted.
1223
1224 .TP
1225 .BI vid " VID"
1226 the VLAN ID for the operation. Match entries only with the specified VLAN ID.
1227
1228 .TP
1229 .BI src_vni " SRC_VNI"
1230 the source VNI Network Identifier for the operation. Match entries only with
1231 the specified source VNI.
1232
1233 .TP
1234 .BI proto " PROTO"
1235 the routing protocol identifier for the operation. Match entries only with the
1236 specified routing protocol. Can be a number or a string from the file
1237 /etc/iproute2/rt_protos.
1238
1239 .TP
1240 .B [no]permanent
1241 if specified then only permanent entries will be deleted or respectively if
1242 "no" is prepended then only non-permanent (temp) entries will be deleted.
1243
1244 .TP
1245 .BI dst " IPADDR"
1246 the IP address of the destination VXLAN tunnel endpoint where the multicast
1247 receivers reside. Match entries only with the specified destination IP.
1248
1249 .TP
1250 .BI dst_port " DST_PORT"
1251 the UDP destination port number to use to connect to the remote VXLAN tunnel
1252 endpoint. Match entries only with the specified destination port number.
1253
1254 .TP
1255 .BI vni " VNI"
1256 the VXLAN VNI Network Identifier to use to connect to the remote VXLAN tunnel
1257 endpoint. Match entries only with the specified destination VNI.
1258
1259 .SH bridge mst - multiple spanning tree port states
1260
1261 In the multiple spanning tree (MST) model, the active paths through a
1262 network can be different for different VLANs. In other words, a
1263 bridge port can simultaneously forward one subset of VLANs, while
1264 blocking another.
1265
1266 Provided that the
1267 .B mst_enable
1268 bridge option is enabled, a group of VLANs can be forwarded along the
1269 same spanning tree by associating them with the same instance (MSTI)
1270 using
1271 .BR "bridge vlan global set" .
1272
1273 .SS bridge mst set - set multiple spanning tree state
1274
1275 Set the spanning tree state for
1276 .IR DEV ,
1277 in the multiple spanning tree instance
1278 .IR MSTI ,
1279 to
1280 .IR STP_STATE .
1281
1282 .TP
1283 .BI dev " DEV"
1284 Interface name of the bridge port.
1285
1286 .TP
1287 .BI msti " MSTI"
1288 The multiple spanning tree instance.
1289
1290 .TP
1291 .BI state " STP_STATE"
1292 The spanning tree state, see the
1293 .B state
1294 option of
1295 .B "bridge link set"
1296 for supported states.
1297
1298 .SS bridge mst show - list MST states
1299
1300 List current MST port states in every MSTI.
1301
1302 .TP
1303 .BI dev " DEV"
1304 If specified, only display states of the bridge port with this
1305 interface name.
1306
1307 .SH bridge vlan - VLAN filter list
1308
1309 .B vlan
1310 objects contain known VLAN IDs for a link.
1311
1312 .P
1313 The corresponding commands display vlan filter entries, add new entries,
1314 and delete old ones.
1315
1316 .SS bridge vlan add - add a new vlan filter entry
1317
1318 This command creates a new vlan filter entry.
1319
1320 .TP
1321 .BI dev " NAME"
1322 the interface with which this vlan is associated.
1323
1324 .TP
1325 .BI vid " VID"
1326 the VLAN ID that identifies the vlan.
1327
1328 .TP
1329 .BI tunnel_info " TUNNEL_ID"
1330 the TUNNEL ID that maps to this vlan. The tunnel id is set in
1331 dst_metadata for every packet that belongs to this vlan (applicable to
1332 bridge ports with vlan_tunnel flag set).
1333
1334 .TP
1335 .B pvid
1336 the vlan specified is to be considered a PVID at ingress.
1337 Any untagged frames will be assigned to this VLAN.
1338
1339 .TP
1340 .B untagged
1341 the vlan specified is to be treated as untagged on egress.
1342
1343 .TP
1344 .B self
1345 the vlan is configured on the specified physical device. Required if the
1346 device is the bridge device.
1347
1348 .TP
1349 .B master
1350 the vlan is configured on the software bridge (default).
1351
1352 .SS bridge vlan delete - delete a vlan filter entry
1353 This command removes an existing vlan filter entry.
1354
1355 .PP
1356 The arguments are the same as with
1357 .BR "bridge vlan add".
1358 The
1359 .BR "pvid " and " untagged"
1360 flags are ignored.
1361
1362 .SS bridge vlan set - change vlan filter entry's options
1363
1364 This command changes vlan filter entry's options.
1365
1366 .TP
1367 .BI dev " NAME"
1368 the interface with which this vlan is associated.
1369
1370 .TP
1371 .BI vid " VID"
1372 the VLAN ID that identifies the vlan.
1373
1374 .TP
1375 .BI state " STP_STATE "
1376 the operation state of the vlan. One may enter STP state name (case insensitive), or one of the
1377 numbers below. Negative inputs are ignored, and unrecognized names return an
1378 error. Note that the state is set only for the vlan of the specified device, e.g. if it is
1379 a bridge port then the state will be set only for the vlan of the port.
1380
1381 .B 0
1382 - vlan is in STP
1383 .B DISABLED
1384 state. Make this vlan completely inactive for STP. This is also called
1385 BPDU filter and could be used to disable STP on an untrusted vlan.
1386 .sp
1387
1388 .B 1
1389 - vlan is in STP
1390 .B LISTENING
1391 state. Only valid if STP is enabled on the bridge. In this
1392 state the vlan listens for STP BPDUs and drops all other traffic frames.
1393 .sp
1394
1395 .B 2
1396 - vlan is in STP
1397 .B LEARNING
1398 state. Only valid if STP is enabled on the bridge. In this
1399 state the vlan will accept traffic only for the purpose of updating MAC
1400 address tables.
1401 .sp
1402
1403 .B 3
1404 - vlan is in STP
1405 .B FORWARDING
1406 state. This is the default vlan state.
1407 .sp
1408
1409 .B 4
1410 - vlan is in STP
1411 .B BLOCKING
1412 state. Only valid if STP is enabled on the bridge. This state
1413 is used during the STP election process. In this state, the vlan will only process
1414 STP BPDUs.
1415 .sp
1416
1417 .TP
1418 .BI mcast_max_groups " MAX_GROUPS "
1419 Sets the maximum number of MDB entries that can be registered for a given
1420 VLAN on a given port. A VLAN-specific equivalent of the per-port option of
1421 the same name, see above for details.
1422
1423 Note that this option is only available when \fBip link\fR option
1424 \fBmcast_vlan_snooping\fR is enabled.
1425
1426 .TP
1427 .BI mcast_router " MULTICAST_ROUTER "
1428 configure this vlan and interface's multicast router mode, note that only modes
1429 0 - 2 are available for bridge devices.
1430 A vlan and interface with a multicast router will receive all multicast traffic.
1431 .I MULTICAST_ROUTER
1432 may be either
1433 .sp
1434 .B 0
1435 - to disable multicast router.
1436 .sp
1437
1438 .B 1
1439 - to let the system detect the presence of routers (default).
1440 .sp
1441
1442 .B 2
1443 - to permanently enable multicast traffic forwarding on this vlan and interface.
1444 .sp
1445
1446 .B 3
1447 - to temporarily mark this vlan and port as having a multicast router, i.e.
1448 enable multicast traffic forwarding. This mode is available only for ports.
1449 .sp
1450
1451 .TP
1452 .BR "neigh_suppress on " or " neigh_suppress off "
1453 Controls whether neigh discovery (arp and nd) proxy and suppression is enabled
1454 for a given VLAN on a given port. By default this flag is off.
1455
1456 Note that this option only takes effect when \fBbridge link\fR option
1457 \fBneigh_vlan_suppress\fR is enabled for a given port.
1458
1459 .SS bridge vlan show - list vlan configuration.
1460
1461 This command displays the current VLAN filter table.
1462
1463 .PP
1464 With the
1465 .B -details
1466 option, the command becomes verbose. It displays the per-vlan options.
1467
1468 .PP
1469 With the
1470 .B -statistics
1471 option, the command displays per-vlan traffic statistics.
1472
1473 .SS bridge vlan tunnelshow - list vlan tunnel mapping.
1474
1475 This command displays the current vlan tunnel info mapping.
1476
1477 .SS bridge vlan global set - change vlan filter entry's global options
1478
1479 This command changes vlan filter entry's global options.
1480
1481 .TP
1482 .BI dev " NAME"
1483 the interface with which this vlan is associated. Only bridge devices are
1484 supported for global options.
1485
1486 .TP
1487 .BI vid " VID"
1488 the VLAN ID that identifies the vlan.
1489
1490 .TP
1491 .BI mcast_snooping " MULTICAST_SNOOPING "
1492 turn multicast snooping for VLAN entry with VLAN ID on
1493 .RI ( MULTICAST_SNOOPING " > 0) "
1494 or off
1495 .RI ( MULTICAST_SNOOPING " == 0). Default is on. "
1496
1497 .TP
1498 .BI mcast_querier " MULTICAST_QUERIER "
1499 enable
1500 .RI ( MULTICAST_QUERIER " > 0) "
1501 or disable
1502 .RI ( MULTICAST_QUERIER " == 0) "
1503 IGMP/MLD querier, ie sending of multicast queries by the bridge. Default is disabled.
1504
1505 .TP
1506 .BI mcast_igmp_version " IGMP_VERSION "
1507 set the IGMP version. Default is 2.
1508
1509 .TP
1510 .BI mcast_mld_version " MLD_VERSION "
1511 set the MLD version. Default is 1.
1512
1513 .TP
1514 .BI mcast_last_member_count " LAST_MEMBER_COUNT "
1515 set multicast last member count, ie the number of queries the bridge
1516 will send before stopping forwarding a multicast group after a "leave"
1517 message has been received. Default is 2.
1518
1519 .TP
1520 .BI mcast_last_member_interval " LAST_MEMBER_INTERVAL "
1521 interval between queries to find remaining members of a group,
1522 after a "leave" message is received.
1523
1524 .TP
1525 .BI mcast_startup_query_count " STARTUP_QUERY_COUNT "
1526 set the number of queries to send during startup phase. Default is 2.
1527
1528 .TP
1529 .BI mcast_startup_query_interval " STARTUP_QUERY_INTERVAL "
1530 interval between queries in the startup phase.
1531
1532 .TP
1533 .BI mcast_membership_interval " MEMBERSHIP_INTERVAL "
1534 delay after which the bridge will leave a group,
1535 if no membership reports for this group are received.
1536
1537 .TP
1538 .BI mcast_querier_interval " QUERIER_INTERVAL "
1539 interval between queries sent by other routers. If no queries are seen
1540 after this delay has passed, the bridge will start to send its own queries
1541 (as if
1542 .BI mcast_querier
1543 was enabled).
1544
1545 .TP
1546 .BI mcast_query_interval " QUERY_INTERVAL "
1547 interval between queries sent by the bridge after the end of the
1548 startup phase.
1549
1550 .TP
1551 .BI mcast_query_response_interval " QUERY_RESPONSE_INTERVAL "
1552 set the Max Response Time/Maximum Response Delay for IGMP/MLD
1553 queries sent by the bridge.
1554
1555 .TP
1556 .BI msti " MSTI "
1557 associate the VLAN with the specified multiple spanning tree instance
1558 (MSTI).
1559
1560 .SS bridge vlan global show - list global vlan options.
1561
1562 This command displays the global VLAN options for each VLAN entry.
1563
1564 .TP
1565 .BI dev " DEV"
1566 the interface only whose VLAN global options should be listed. Default is to list
1567 all bridge interfaces.
1568
1569 .TP
1570 .BI vid " VID"
1571 the VLAN ID only whose global options should be listed. Default is to list
1572 all vlans.
1573
1574 .SH bridge vni - VNI filter list
1575
1576 .B vni
1577 objects contain known VNI IDs for a dst metadata vxlan link.
1578
1579 .P
1580 The corresponding commands display vni filter entries, add new entries,
1581 and delete old ones.
1582
1583 .SS bridge vni add - add a new vni filter entry
1584
1585 This command creates a new vni filter entry.
1586
1587 .TP
1588 .BI dev " NAME"
1589 the interface with which this vni is associated.
1590
1591 .TP
1592 .BI vni " VNI"
1593 the VNI ID that identifies the vni.
1594
1595 .TP
1596 .BI remote " IPADDR"
1597 specifies the unicast destination IP address to use in outgoing packets
1598 when the destination link layer address is not known in the VXLAN device
1599 forwarding database. This parameter cannot be specified with the group.
1600
1601 .TP
1602 .BI group " IPADDR"
1603 specifies the multicast IP address to join for this VNI
1604
1605 .SS bridge vni del - delete a new vni filter entry
1606
1607 This command removes an existing vni filter entry.
1608
1609 .PP
1610 The arguments are the same as with
1611 .BR "bridge vni add".
1612
1613 .SS bridge vni show - list vni filtering configuration.
1614
1615 This command displays the current vni filter table.
1616
1617 .PP
1618 With the
1619 .B -statistics
1620 option, the command displays per-vni traffic statistics.
1621
1622 .TP
1623 .BI dev " NAME"
1624 shows vni filtering table associated with the vxlan device
1625
1626 .SH bridge monitor - state monitoring
1627
1628 The
1629 .B bridge
1630 utility can monitor the state of devices and addresses
1631 continuously. This option has a slightly different format.
1632 Namely, the
1633 .B monitor
1634 command is the first in the command line and then the object list follows:
1635
1636 .BR "bridge monitor" " [ " all " |"
1637 .IR OBJECT-LIST " ]"
1638
1639 .I OBJECT-LIST
1640 is the list of object types that we want to monitor.
1641 It may contain
1642 .BR link ", " fdb ", " vlan " and " mdb "."
1643 If no
1644 .B file
1645 argument is given,
1646 .B bridge
1647 opens RTNETLINK, listens on it and dumps state changes in the format
1648 described in previous sections.
1649
1650 .P
1651 If a file name is given, it does not listen on RTNETLINK,
1652 but opens the file containing RTNETLINK messages saved in binary format
1653 and dumps them.
1654
1655 .SH NOTES
1656 This command uses facilities added in Linux 3.0.
1657
1658 Although the forwarding table is maintained on a per-bridge device basis
1659 the bridge device is not part of the syntax. This is a limitation of the
1660 underlying netlink neighbour message protocol. When displaying the
1661 forwarding table, entries for all bridges are displayed.
1662 Add/delete/modify commands determine the underlying bridge device
1663 based on the bridge to which the corresponding ethernet device is attached.
1664
1665
1666 .SH SEE ALSO
1667 .BR ip (8)
1668 .SH BUGS
1669 .RB "Please direct bugreports and patches to: " <[email protected]>
1670
1671 .SH AUTHOR
1672 Original Manpage by Stephen Hemminger