1 .TH BRIDGE 8 "1 August 2012" "iproute2" "Linux"
3 bridge \- show / manipulate bridge addresses and devices
10 .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
16 .BR link " | " fdb " | " mdb " | " vlan " | " monitor " }"
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\-c\fR[\folor\fR] |
26 \fB\-p\fR[\fIretty\fR] |
27 \fB\-j\fR[\fIson\fR] }
40 .BR guard " { " on " | " off " } ] [ "
41 .BR hairpin " { " on " | " off " } ] [ "
42 .BR fastleave " { " on " | " off " } ] [ "
43 .BR root_block " { " on " | " off " } ] [ "
44 .BR learning " { " on " | " off " } ] [ "
45 .BR learning_sync " { " on " | " off " } ] [ "
46 .BR flood " { " on " | " off " } ] [ "
47 .BR hwmode " { " vepa " | " veb " } ] [ "
48 .BR mcast_flood " { " on " | " off " } ] [ "
49 .BR neigh_suppress " { " on " | " off " } ] [ "
50 .BR vlan_tunnel " { " on " | " off " } ] [ "
51 .BR self " ] [ " master " ]"
54 .BR "bridge link" " [ " show " ] [ "
59 .BR "bridge fdb" " { " add " | " append " | " del " | " replace " } "
63 .BR local " | " static " | " dynamic " } [ "
64 .BR self " ] [ " master " ] [ " router " ] [ " use " ] [ " extern_learn " ] [ "
75 .BR "bridge fdb" " [ " show " ] [ "
88 .BR "bridge mdb" " { " add " | " del " } "
95 .BR permanent " | " temp " ] [ "
100 .BR "bridge mdb show " [ "
105 .BR "bridge vlan" " { " add " | " del " } "
111 .IR TUNNEL_ID " ] [ "
112 .BR pvid " ] [ " untagged " ] [ "
113 .BR self " ] [ " master " ] "
116 .BR "bridge vlan" " [ " show " | " tunnelshow " ] [ "
121 .BR "bridge monitor" " [ " all " | " neigh " | " link " | " mdb " ]"
126 .BR "\-V" , " -Version"
127 print the version of the
132 .BR "\-s" , " \-stats", " \-statistics"
133 output more information. If this option
134 is given multiple times, the amount of information increases.
135 As a rule, the information is statistics or some time values.
138 .BR "\-d" , " \-details"
139 print detailed information about MDB router ports.
142 .BR "\-n" , " \-net" , " \-netns " <NETNS>
145 to the specified network namespace
147 Actually it just simplifies executing of:
152 .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
158 .RI "-n[etns] " NETNS " [ " OPTIONS " ] " OBJECT " { " COMMAND " | "
162 .BR "\-b", " \-batch " <FILENAME>
163 Read commands from provided file or standard input and invoke them.
164 First failure will cause termination of bridge command.
168 Don't terminate bridge command on errors in batch mode.
169 If there were any errors during execution of the commands, the application
170 return code will be non zero.
173 .BR "\-c" , " -color"
178 Output results in JavaScript Object Notation (JSON).
181 .BR "\-p", " \-pretty"
182 When combined with -j generate a pretty JSON output.
185 .SH BRIDGE - COMMAND SYNTAX
196 - Forwarding Database entry.
200 - Multicast group database entry.
209 Specifies the action to perform on the object.
210 The set of possible actions depends on the object type.
211 As a rule, it is possible to
212 .BR "add" , " delete"
217 ) objects, but some objects do not allow all of these operations
218 or have some additional commands. The
220 command is available for all objects. It prints
221 out a list of available commands and argument syntax conventions.
223 If no command is given, some default command is assumed.
226 or, if the objects of this class cannot be listed,
229 .SH bridge link - bridge port
232 objects correspond to the port devices of the bridge.
235 The corresponding commands set and display port status and bridge specific
238 .SS bridge link set - set bridge specific attributes on a port
242 interface name of the bridge port
246 the STP path cost of the specified port.
249 .BI priority " PRIO "
250 the STP port priority. The priority value is an unsigned 8-bit quantity
251 (number between 0 and 255). This metric is used in the designated port an
252 droot port selectio algorithms.
256 the operation state of the port. This is primarily used by user space STP/RSTP
257 implementation. One may enter a lowercased port state name, or one of the
258 numbers below. Negative inputs are ignored, and unrecognized names return an
262 - port is DISABLED. Make this port completely inactive.
266 - STP LISTENING state. Only valid if STP is enabled on the bridge. In this
267 state the port listens for STP BPDUs and drops all other traffic frames.
271 - STP LEARNING state. Only valid if STP is enabled on the bridge. In this
272 state the port will accept traffic only for the purpose of updating MAC
277 - STP FORWARDING state. Port is fully active.
281 - STP BLOCKING state. Only valid if STP is enabled on the bridge. This state
282 is used during the STP election process. In this state, port will only process
287 .BR "guard on " or " guard off "
288 Controls whether STP BPDUs will be processed by the bridge port. By default,
289 the flag is turned off allowed BPDU processing. Turning this flag on will
290 cause the port to stop processing STP BPDUs.
293 .BR "hairpin on " or " hairpin off "
294 Controls whether traffic may be send back out of the port on which it was
295 received. By default, this flag is turned off and the bridge will not forward
296 traffic back out of the receiving port.
299 .BR "fastleave on " or " fastleave off "
300 This flag allows the bridge to immediately stop multicast traffic on a port
301 that receives IGMP Leave message. It is only used with IGMP snooping is
302 enabled on the bridge. By default the flag is off.
305 .BR "root_block on " or " root_block off "
306 Controls whether a given port is allowed to become root port or not. Only used
307 when STP is enabled on the bridge. By default the flag is off.
310 .BR "learning on " or " learning off "
311 Controls whether a given port will learn MAC addresses from received traffic or
312 not. If learning if off, the bridge will end up flooding any traffic for which
313 it has no FDB entry. By default this flag is on.
316 .BR "learning_sync on " or " learning_sync off "
317 Controls whether a given port will sync MAC addresses learned on device port to
321 .BR "flooding on " or " flooding off "
322 Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on.
326 Some network interface cards support HW bridge functionality and they may be
327 configured in different modes. Currently support modes are:
330 - Data sent between HW ports is sent on the wire to the external
334 - bridging happens in hardware.
337 .BR "mcast_flood on " or " mcast_flood off "
338 Controls whether a given port will be flooded with multicast traffic for which there is no MDB entry. By default this flag is on.
341 .BR "neigh_suppress on " or " neigh_suppress off "
342 Controls whether neigh discovery (arp and nd) proxy and suppression is enabled on the port. By default this flag is off.
345 .BR "vlan_tunnel on " or " vlan_tunnel off "
346 Controls whether vlan to tunnel mapping is enabled on the port. By default this flag is off.
350 link setting is configured on specified physical device
354 link setting is configured on the software bridge (default)
357 .BR "\-t" , " \-timestamp"
358 display current time when using monitor option.
360 .SS bridge link show - list bridge port configuration.
362 This command displays the current bridge port configuration and flags.
364 .SH bridge fdb - forwarding database management
367 objects contain known Ethernet addresses on a link.
370 The corresponding commands display fdb entries, add new entries,
374 .SS bridge fdb add - add a new fdb entry
376 This command creates a new fdb entry.
380 the Ethernet MAC address.
384 the interface to which this address is associated.
387 - is a local permanent fdb entry
391 - is a static (no arp) fdb entry
395 - is a dynamic reachable age-able fdb entry
399 - the address is associated with the port drivers fdb. Usually hardware.
403 - the address is associated with master devices fdb. Usually software (default).
407 - the destination address is associated with a router.
408 Valid if the referenced device is a VXLAN type device and has
409 route shortcircuit enabled.
413 - the address is in use. User space can use this option to
414 indicate to the kernel that the fdb entry is in use.
418 - this entry was learned externally. This option can be used to
419 indicate to the kernel that an entry was hardware or user-space
420 controller learnt dynamic entry. Kernel will not age such an entry.
424 The next command line parameters apply only
425 when the specified device
430 the IP address of the destination
431 VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
435 the VXLAN VNI Network Identifier (or VXLAN Segment ID)
436 to use to connect to the remote VXLAN tunnel endpoint.
437 If omitted the value specified at vxlan device creation
442 the UDP destination PORT number to use to connect to the
443 remote VXLAN tunnel endpoint.
444 If omitted the default value is used.
448 device name of the outgoing interface for the
449 VXLAN device driver to reach the
450 remote VXLAN tunnel endpoint.
452 .SS bridge fdb append - append a forwarding database entry
453 This command adds a new fdb entry with an already known
455 Valid only for multicast link layer addresses.
456 The command adds support for broadcast and multicast
457 Ethernet MAC addresses.
458 The Ethernet MAC address is added multiple times into
459 the forwarding database and the vxlan device driver
460 sends a copy of the data packet to each entry found.
463 The arguments are the same as with
464 .BR "bridge fdb add" .
466 .SS bridge fdb delete - delete a forwarding database entry
467 This command removes an existing fdb entry.
470 The arguments are the same as with
471 .BR "bridge fdb add" .
473 .SS bridge fdb replace - replace a forwarding database entry
474 If no matching entry is found, a new one will be created instead.
477 The arguments are the same as with
478 .BR "bridge fdb add" .
480 .SS bridge fdb show - list forwarding entries.
482 This command displays the current forwarding table.
487 option, the command becomes verbose. It prints out the last updated
488 and last used time for each entry.
490 .SH bridge mdb - multicast group database management
493 objects contain known IP multicast group addresses on a link.
496 The corresponding commands display mdb entries, add new entries,
499 .SS bridge mdb add - add a new multicast group database entry
501 This command creates a new mdb entry.
505 the interface where this group address is associated.
509 the port whose link is known to have members of this multicast group.
513 the IP multicast group address whose members reside on the link connected to
517 - the mdb entry is permanent
521 - the mdb entry is temporary (default)
526 the VLAN ID which is known to have members of this multicast group.
529 .SS bridge mdb delete - delete a multicast group database entry
530 This command removes an existing mdb entry.
533 The arguments are the same as with
534 .BR "bridge mdb add" .
536 .SS bridge mdb show - list multicast group database entries
538 This command displays the current multicast group membership table. The table
539 is populated by IGMP and MLD snooping in the bridge driver automatically. It
544 commands manually too.
548 the interface only whose entries should be listed. Default is to list all
554 option, the command becomes verbose. It prints out the ports known to have
560 option, the command displays timer values for mdb and router port entries.
562 .SH bridge vlan - VLAN filter list
565 objects contain known VLAN IDs for a link.
568 The corresponding commands display vlan filter entries, add new entries,
571 .SS bridge vlan add - add a new vlan filter entry
573 This command creates a new vlan filter entry.
577 the interface with which this vlan is associated.
581 the VLAN ID that identifies the vlan.
584 .BI tunnel_info " TUNNEL_ID"
585 the TUNNEL ID that maps to this vlan. The tunnel id is set in dst_metadata for
586 every packet that belongs to this vlan (applicable to bridge ports with vlan_tunnel
591 the vlan specified is to be considered a PVID at ingress.
592 Any untagged frames will be assigned to this VLAN.
596 the vlan specified is to be treated as untagged on egress.
600 the vlan is configured on the specified physical device. Required if the
601 device is the bridge device.
605 the vlan is configured on the software bridge (default).
607 .SS bridge vlan delete - delete a vlan filter entry
608 This command removes an existing vlan filter entry.
611 The arguments are the same as with
612 .BR "bridge vlan add".
614 .BR "pvid " and " untagged"
617 .SS bridge vlan show - list vlan configuration.
619 This command displays the current VLAN filter table.
624 option, the command displays per-vlan traffic statistics.
626 .SS bridge vlan tunnelshow - list vlan tunnel mapping.
628 This command displays the current vlan tunnel info mapping.
630 .SH bridge monitor - state monitoring
634 utility can monitor the state of devices and addresses
635 continuously. This option has a slightly different format.
638 command is the first in the command line and then the object list follows:
640 .BR "bridge monitor" " [ " all " |"
644 is the list of object types that we want to monitor.
646 .BR link ", " fdb ", and " mdb "."
651 opens RTNETLINK, listens on it and dumps state changes in the format
652 described in previous sections.
655 If a file name is given, it does not listen on RTNETLINK,
656 but opens the file containing RTNETLINK messages saved in binary format
660 This command uses facilities added in Linux 3.0.
662 Although the forwarding table is maintained on a per-bridge device basis
663 the bridge device is not part of the syntax. This is a limitation of the
664 underlying netlink neighbour message protocol. When displaying the
665 forwarding table, entries for all bridges are displayed.
666 Add/delete/modify commands determine the underlying bridge device
667 based on the bridge to which the corresponding ethernet device is attached.
673 .RB "Please direct bugreports and patches to: " <netdev@vger.kernel.org>
676 Original Manpage by Stephen Hemminger