Debian Codegraph @

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