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] |
28 \fB\-o\fR[\fIneline\fr] }
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 mcast_flood " { " on " | " off " } ] [ "
50 .BR mcast_to_unicast " { " on " | " off " } ] [ "
51 .BR neigh_suppress " { " on " | " off " } ] [ "
52 .BR vlan_tunnel " { " on " | " off " } ] [ "
53 .BR isolated " { " on " | " off " } ] [ "
56 .BR nobackup_port " ] [ "
57 .BR self " ] [ " master " ]"
60 .BR "bridge link" " [ " show " ] [ "
65 .BR "bridge fdb" " { " add " | " append " | " del " | " replace " } "
69 .BR local " | " static " | " dynamic " } [ "
70 .BR self " ] [ " master " ] [ " router " ] [ " use " ] [ " extern_learn " ] [ " sticky " ] [ "
83 .BR "bridge fdb" " [ " show " ] [ "
104 .BR self " ] [ " master " ]"
107 .BR "bridge mdb" " { " add " | " del " } "
114 .BR permanent " | " temp " ] [ "
119 .BR "bridge mdb show " [ "
124 .BR "bridge vlan" " { " add " | " del " } "
130 .IR TUNNEL_ID " ] [ "
131 .BR pvid " ] [ " untagged " ] [ "
132 .BR self " ] [ " master " ] "
135 .BR "bridge vlan" " [ " show " | " tunnelshow " ] [ "
140 .BR "bridge monitor" " [ " all " | " neigh " | " link " | " mdb " ]"
145 .BR "\-V" , " -Version"
146 print the version of the
151 .BR "\-s" , " \-stats", " \-statistics"
152 output more information. If this option
153 is given multiple times, the amount of information increases.
154 As a rule, the information is statistics or some time values.
157 .BR "\-d" , " \-details"
158 print detailed information about MDB router ports.
161 .BR "\-n" , " \-net" , " \-netns " <NETNS>
164 to the specified network namespace
166 Actually it just simplifies executing of:
171 .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
177 .RI "-n[etns] " NETNS " [ " OPTIONS " ] " OBJECT " { " COMMAND " | "
181 .BR "\-b", " \-batch " <FILENAME>
182 Read commands from provided file or standard input and invoke them.
183 First failure will cause termination of bridge command.
187 Don't terminate bridge command on errors in batch mode.
188 If there were any errors during execution of the commands, the application
189 return code will be non zero.
192 .BR \-c [ color ][ = { always | auto | never }
193 Configure color output. If parameter is omitted or
195 color output is enabled regardless of stdout state. If parameter is
197 stdout is checked to be a terminal before enabling color output. If parameter is
199 color output is disabled. If specified multiple times, the last one takes
200 precedence. This flag is ignored if
206 Output results in JavaScript Object Notation (JSON).
209 .BR "\-p", " \-pretty"
210 When combined with -j generate a pretty JSON output.
213 .BR "\-o", " \-oneline"
214 output each record on a single line, replacing line feeds
217 character. This is convenient when you want to count records
225 .SH BRIDGE - COMMAND SYNTAX
236 - Forwarding Database entry.
240 - Multicast group database entry.
249 Specifies the action to perform on the object.
250 The set of possible actions depends on the object type.
251 As a rule, it is possible to
252 .BR "add" , " delete"
257 ) objects, but some objects do not allow all of these operations
258 or have some additional commands. The
260 command is available for all objects. It prints
261 out a list of available commands and argument syntax conventions.
263 If no command is given, some default command is assumed.
266 or, if the objects of this class cannot be listed,
269 .SH bridge link - bridge port
272 objects correspond to the port devices of the bridge.
275 The corresponding commands set and display port status and bridge specific
278 .SS bridge link set - set bridge specific attributes on a port
282 interface name of the bridge port
286 the STP path cost of the specified port.
289 .BI priority " PRIO "
290 the STP port priority. The priority value is an unsigned 8-bit quantity
291 (number between 0 and 255). This metric is used in the designated port an
292 droot port selectio algorithms.
296 the operation state of the port. This is primarily used by user space STP/RSTP
297 implementation. One may enter a lowercased port state name, or one of the
298 numbers below. Negative inputs are ignored, and unrecognized names return an
302 - port is DISABLED. Make this port completely inactive.
306 - STP LISTENING state. Only valid if STP is enabled on the bridge. In this
307 state the port listens for STP BPDUs and drops all other traffic frames.
311 - STP LEARNING state. Only valid if STP is enabled on the bridge. In this
312 state the port will accept traffic only for the purpose of updating MAC
317 - STP FORWARDING state. Port is fully active.
321 - STP BLOCKING state. Only valid if STP is enabled on the bridge. This state
322 is used during the STP election process. In this state, port will only process
327 .BR "guard on " or " guard off "
328 Controls whether STP BPDUs will be processed by the bridge port. By default,
329 the flag is turned off allowed BPDU processing. Turning this flag on will
330 cause the port to stop processing STP BPDUs.
333 .BR "hairpin on " or " hairpin off "
334 Controls whether traffic may be send back out of the port on which it was
335 received. By default, this flag is turned off and the bridge will not forward
336 traffic back out of the receiving port.
339 .BR "fastleave on " or " fastleave off "
340 This flag allows the bridge to immediately stop multicast traffic on a port
341 that receives IGMP Leave message. It is only used with IGMP snooping is
342 enabled on the bridge. By default the flag is off.
345 .BR "root_block on " or " root_block off "
346 Controls whether a given port is allowed to become root port or not. Only used
347 when STP is enabled on the bridge. By default the flag is off.
350 .BR "learning on " or " learning off "
351 Controls whether a given port will learn MAC addresses from received traffic or
352 not. If learning if off, the bridge will end up flooding any traffic for which
353 it has no FDB entry. By default this flag is on.
356 .BR "learning_sync on " or " learning_sync off "
357 Controls whether a given port will sync MAC addresses learned on device port to
361 .BR "flood on " or " flood off "
362 Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on.
366 Some network interface cards support HW bridge functionality and they may be
367 configured in different modes. Currently support modes are:
370 - Data sent between HW ports is sent on the wire to the external
374 - bridging happens in hardware.
377 .BR "mcast_flood on " or " mcast_flood off "
378 Controls whether a given port will flood multicast traffic for which
379 there is no MDB entry. By default this flag is on.
382 .BR "mcast_to_unicast on " or " mcast_to_unicast off "
383 Controls whether a given port will replicate packets using unicast
384 instead of multicast. By default this flag is off.
387 .BR "neigh_suppress on " or " neigh_suppress off "
388 Controls whether neigh discovery (arp and nd) proxy and suppression is
389 enabled on the port. By default this flag is off.
392 .BR "vlan_tunnel on " or " vlan_tunnel off "
393 Controls whether vlan to tunnel mapping is enabled on the port. By
394 default this flag is off.
397 .BR "isolated on " or " isolated off "
398 Controls whether a given port will be isolated, which means it will be
399 able to communicate with non-isolated ports only. By default this
403 .BI backup_port " DEVICE"
404 If the port loses carrier all traffic will be redirected to the
405 configured backup port
409 Removes the currently configured backup port
413 link setting is configured on specified physical device
417 link setting is configured on the software bridge (default)
420 .BR "\-t" , " \-timestamp"
421 display current time when using monitor option.
423 .SS bridge link show - list ports configuration for all bridges.
425 This command displays port configuration and flags for all bridges.
427 To display port configuration and flags for a specific bridge, use the
428 "ip link show master <bridge_device>" command.
430 .SH bridge fdb - forwarding database management
433 objects contain known Ethernet addresses on a link.
436 The corresponding commands display fdb entries, add new entries,
440 .SS bridge fdb add - add a new fdb entry
442 This command creates a new fdb entry.
446 the Ethernet MAC address.
450 the interface to which this address is associated.
453 - is a local permanent fdb entry
457 - is a static (no arp) fdb entry
461 - is a dynamic reachable age-able fdb entry
465 - the address is associated with the port drivers fdb. Usually hardware.
469 - the address is associated with master devices fdb. Usually software (default).
473 - the destination address is associated with a router.
474 Valid if the referenced device is a VXLAN type device and has
475 route shortcircuit enabled.
479 - the address is in use. User space can use this option to
480 indicate to the kernel that the fdb entry is in use.
484 - this entry was learned externally. This option can be used to
485 indicate to the kernel that an entry was hardware or user-space
486 controller learnt dynamic entry. Kernel will not age such an entry.
490 - this entry will not change its port due to learning.
494 The next command line parameters apply only
495 when the specified device
500 the IP address of the destination
501 VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
505 the src VNI Network Identifier (or VXLAN Segment ID)
506 this entry belongs to. Used only when the vxlan device is in
507 external or collect metadata mode. If omitted the value specified at
508 vxlan device creation will be used.
512 the VXLAN VNI Network Identifier (or VXLAN Segment ID)
513 to use to connect to the remote VXLAN tunnel endpoint.
514 If omitted the value specified at vxlan device creation
519 the UDP destination PORT number to use to connect to the
520 remote VXLAN tunnel endpoint.
521 If omitted the default value is used.
525 device name of the outgoing interface for the
526 VXLAN device driver to reach the
527 remote VXLAN tunnel endpoint.
529 .SS bridge fdb append - append a forwarding database entry
530 This command adds a new fdb entry with an already known
532 Valid only for multicast link layer addresses.
533 The command adds support for broadcast and multicast
534 Ethernet MAC addresses.
535 The Ethernet MAC address is added multiple times into
536 the forwarding database and the vxlan device driver
537 sends a copy of the data packet to each entry found.
540 The arguments are the same as with
541 .BR "bridge fdb add" .
543 .SS bridge fdb delete - delete a forwarding database entry
544 This command removes an existing fdb entry.
547 The arguments are the same as with
548 .BR "bridge fdb add" .
550 .SS bridge fdb replace - replace a forwarding database entry
551 If no matching entry is found, a new one will be created instead.
554 The arguments are the same as with
555 .BR "bridge fdb add" .
557 .SS bridge fdb show - list forwarding entries.
559 This command displays the current forwarding table.
564 option, the command becomes verbose. It prints out the last updated
565 and last used time for each entry.
567 .SS bridge fdb get - get bridge forwarding entry.
569 lookup a bridge forwarding table entry.
573 the Ethernet MAC address.
577 the interface to which this address is associated.
581 the bridge port to which this address is associated. same as dev above.
585 the bridge to which this address is associated.
589 - the address is associated with the port drivers fdb. Usually hardware.
593 - the address is associated with master devices fdb. Usually software (default).
596 .SH bridge mdb - multicast group database management
599 objects contain known IP multicast group addresses on a link.
602 The corresponding commands display mdb entries, add new entries,
605 .SS bridge mdb add - add a new multicast group database entry
607 This command creates a new mdb entry.
611 the interface where this group address is associated.
615 the port whose link is known to have members of this multicast group.
619 the IP multicast group address whose members reside on the link connected to
623 - the mdb entry is permanent
627 - the mdb entry is temporary (default)
632 the VLAN ID which is known to have members of this multicast group.
635 .SS bridge mdb delete - delete a multicast group database entry
636 This command removes an existing mdb entry.
639 The arguments are the same as with
640 .BR "bridge mdb add" .
642 .SS bridge mdb show - list multicast group database entries
644 This command displays the current multicast group membership table. The table
645 is populated by IGMP and MLD snooping in the bridge driver automatically. It
650 commands manually too.
654 the interface only whose entries should be listed. Default is to list all
660 option, the command becomes verbose. It prints out the ports known to have
666 option, the command displays timer values for mdb and router port entries.
668 .SH bridge vlan - VLAN filter list
671 objects contain known VLAN IDs for a link.
674 The corresponding commands display vlan filter entries, add new entries,
677 .SS bridge vlan add - add a new vlan filter entry
679 This command creates a new vlan filter entry.
683 the interface with which this vlan is associated.
687 the VLAN ID that identifies the vlan.
690 .BI tunnel_info " TUNNEL_ID"
691 the TUNNEL ID that maps to this vlan. The tunnel id is set in
692 dst_metadata for every packet that belongs to this vlan (applicable to
693 bridge ports with vlan_tunnel flag set).
697 the vlan specified is to be considered a PVID at ingress.
698 Any untagged frames will be assigned to this VLAN.
702 the vlan specified is to be treated as untagged on egress.
706 the vlan is configured on the specified physical device. Required if the
707 device is the bridge device.
711 the vlan is configured on the software bridge (default).
713 .SS bridge vlan delete - delete a vlan filter entry
714 This command removes an existing vlan filter entry.
717 The arguments are the same as with
718 .BR "bridge vlan add".
720 .BR "pvid " and " untagged"
723 .SS bridge vlan show - list vlan configuration.
725 This command displays the current VLAN filter table.
730 option, the command displays per-vlan traffic statistics.
732 .SS bridge vlan tunnelshow - list vlan tunnel mapping.
734 This command displays the current vlan tunnel info mapping.
736 .SH bridge monitor - state monitoring
740 utility can monitor the state of devices and addresses
741 continuously. This option has a slightly different format.
744 command is the first in the command line and then the object list follows:
746 .BR "bridge monitor" " [ " all " |"
750 is the list of object types that we want to monitor.
752 .BR link ", " fdb ", and " mdb "."
757 opens RTNETLINK, listens on it and dumps state changes in the format
758 described in previous sections.
761 If a file name is given, it does not listen on RTNETLINK,
762 but opens the file containing RTNETLINK messages saved in binary format
766 This command uses facilities added in Linux 3.0.
768 Although the forwarding table is maintained on a per-bridge device basis
769 the bridge device is not part of the syntax. This is a limitation of the
770 underlying netlink neighbour message protocol. When displaying the
771 forwarding table, entries for all bridges are displayed.
772 Add/delete/modify commands determine the underlying bridge device
773 based on the bridge to which the corresponding ethernet device is attached.
779 .RB "Please direct bugreports and patches to: " <netdev@vger.kernel.org>
782 Original Manpage by Stephen Hemminger