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 neigh_suppress " { " on " | " off " } ] [ "
51 .BR vlan_tunnel " { " on " | " off " } ] [ "
52 .BR isolated " { " on " | " off " } ] [ "
53 .BR self " ] [ " master " ]"
56 .BR "bridge link" " [ " show " ] [ "
61 .BR "bridge fdb" " { " add " | " append " | " del " | " replace " } "
65 .BR local " | " static " | " dynamic " } [ "
66 .BR self " ] [ " master " ] [ " router " ] [ " use " ] [ " extern_learn " ] [ "
77 .BR "bridge fdb" " [ " show " ] [ "
90 .BR "bridge mdb" " { " add " | " del " } "
97 .BR permanent " | " temp " ] [ "
102 .BR "bridge mdb show " [ "
107 .BR "bridge vlan" " { " add " | " del " } "
113 .IR TUNNEL_ID " ] [ "
114 .BR pvid " ] [ " untagged " ] [ "
115 .BR self " ] [ " master " ] "
118 .BR "bridge vlan" " [ " show " | " tunnelshow " ] [ "
123 .BR "bridge monitor" " [ " all " | " neigh " | " link " | " mdb " ]"
128 .BR "\-V" , " -Version"
129 print the version of the
134 .BR "\-s" , " \-stats", " \-statistics"
135 output more information. If this option
136 is given multiple times, the amount of information increases.
137 As a rule, the information is statistics or some time values.
140 .BR "\-d" , " \-details"
141 print detailed information about MDB router ports.
144 .BR "\-n" , " \-net" , " \-netns " <NETNS>
147 to the specified network namespace
149 Actually it just simplifies executing of:
154 .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
160 .RI "-n[etns] " NETNS " [ " OPTIONS " ] " OBJECT " { " COMMAND " | "
164 .BR "\-b", " \-batch " <FILENAME>
165 Read commands from provided file or standard input and invoke them.
166 First failure will cause termination of bridge command.
170 Don't terminate bridge command on errors in batch mode.
171 If there were any errors during execution of the commands, the application
172 return code will be non zero.
175 .BR "\-c" , " -color"
180 Output results in JavaScript Object Notation (JSON).
183 .BR "\-p", " \-pretty"
184 When combined with -j generate a pretty JSON output.
187 .BR "\-o", " \-oneline"
188 output each record on a single line, replacing line feeds
191 character. This is convenient when you want to count records
199 .SH BRIDGE - COMMAND SYNTAX
210 - Forwarding Database entry.
214 - Multicast group database entry.
223 Specifies the action to perform on the object.
224 The set of possible actions depends on the object type.
225 As a rule, it is possible to
226 .BR "add" , " delete"
231 ) objects, but some objects do not allow all of these operations
232 or have some additional commands. The
234 command is available for all objects. It prints
235 out a list of available commands and argument syntax conventions.
237 If no command is given, some default command is assumed.
240 or, if the objects of this class cannot be listed,
243 .SH bridge link - bridge port
246 objects correspond to the port devices of the bridge.
249 The corresponding commands set and display port status and bridge specific
252 .SS bridge link set - set bridge specific attributes on a port
256 interface name of the bridge port
260 the STP path cost of the specified port.
263 .BI priority " PRIO "
264 the STP port priority. The priority value is an unsigned 8-bit quantity
265 (number between 0 and 255). This metric is used in the designated port an
266 droot port selectio algorithms.
270 the operation state of the port. This is primarily used by user space STP/RSTP
271 implementation. One may enter a lowercased port state name, or one of the
272 numbers below. Negative inputs are ignored, and unrecognized names return an
276 - port is DISABLED. Make this port completely inactive.
280 - STP LISTENING state. Only valid if STP is enabled on the bridge. In this
281 state the port listens for STP BPDUs and drops all other traffic frames.
285 - STP LEARNING state. Only valid if STP is enabled on the bridge. In this
286 state the port will accept traffic only for the purpose of updating MAC
291 - STP FORWARDING state. Port is fully active.
295 - STP BLOCKING state. Only valid if STP is enabled on the bridge. This state
296 is used during the STP election process. In this state, port will only process
301 .BR "guard on " or " guard off "
302 Controls whether STP BPDUs will be processed by the bridge port. By default,
303 the flag is turned off allowed BPDU processing. Turning this flag on will
304 cause the port to stop processing STP BPDUs.
307 .BR "hairpin on " or " hairpin off "
308 Controls whether traffic may be send back out of the port on which it was
309 received. By default, this flag is turned off and the bridge will not forward
310 traffic back out of the receiving port.
313 .BR "fastleave on " or " fastleave off "
314 This flag allows the bridge to immediately stop multicast traffic on a port
315 that receives IGMP Leave message. It is only used with IGMP snooping is
316 enabled on the bridge. By default the flag is off.
319 .BR "root_block on " or " root_block off "
320 Controls whether a given port is allowed to become root port or not. Only used
321 when STP is enabled on the bridge. By default the flag is off.
324 .BR "learning on " or " learning off "
325 Controls whether a given port will learn MAC addresses from received traffic or
326 not. If learning if off, the bridge will end up flooding any traffic for which
327 it has no FDB entry. By default this flag is on.
330 .BR "learning_sync on " or " learning_sync off "
331 Controls whether a given port will sync MAC addresses learned on device port to
335 .BR "flooding on " or " flooding off "
336 Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on.
340 Some network interface cards support HW bridge functionality and they may be
341 configured in different modes. Currently support modes are:
344 - Data sent between HW ports is sent on the wire to the external
348 - bridging happens in hardware.
351 .BR "mcast_flood on " or " mcast_flood off "
352 Controls whether a given port will be flooded with multicast traffic for which there is no MDB entry. By default this flag is on.
355 .BR "neigh_suppress on " or " neigh_suppress off "
356 Controls whether neigh discovery (arp and nd) proxy and suppression is enabled on the port. By default this flag is off.
359 .BR "vlan_tunnel on " or " vlan_tunnel off "
360 Controls whether vlan to tunnel mapping is enabled on the port. By default this flag is off.
363 .BR "isolated on " or " isolated off "
364 Controls whether a given port will be isolated, which means it will be able to communicate with non-isolated ports only.
365 By default this flag is off.
369 link setting is configured on specified physical device
373 link setting is configured on the software bridge (default)
376 .BR "\-t" , " \-timestamp"
377 display current time when using monitor option.
379 .SS bridge link show - list bridge port configuration.
381 This command displays the current bridge port configuration and flags.
383 .SH bridge fdb - forwarding database management
386 objects contain known Ethernet addresses on a link.
389 The corresponding commands display fdb entries, add new entries,
393 .SS bridge fdb add - add a new fdb entry
395 This command creates a new fdb entry.
399 the Ethernet MAC address.
403 the interface to which this address is associated.
406 - is a local permanent fdb entry
410 - is a static (no arp) fdb entry
414 - is a dynamic reachable age-able fdb entry
418 - the address is associated with the port drivers fdb. Usually hardware.
422 - the address is associated with master devices fdb. Usually software (default).
426 - the destination address is associated with a router.
427 Valid if the referenced device is a VXLAN type device and has
428 route shortcircuit enabled.
432 - the address is in use. User space can use this option to
433 indicate to the kernel that the fdb entry is in use.
437 - this entry was learned externally. This option can be used to
438 indicate to the kernel that an entry was hardware or user-space
439 controller learnt dynamic entry. Kernel will not age such an entry.
443 The next command line parameters apply only
444 when the specified device
449 the IP address of the destination
450 VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
454 the VXLAN VNI Network Identifier (or VXLAN Segment ID)
455 to use to connect to the remote VXLAN tunnel endpoint.
456 If omitted the value specified at vxlan device creation
461 the UDP destination PORT number to use to connect to the
462 remote VXLAN tunnel endpoint.
463 If omitted the default value is used.
467 device name of the outgoing interface for the
468 VXLAN device driver to reach the
469 remote VXLAN tunnel endpoint.
471 .SS bridge fdb append - append a forwarding database entry
472 This command adds a new fdb entry with an already known
474 Valid only for multicast link layer addresses.
475 The command adds support for broadcast and multicast
476 Ethernet MAC addresses.
477 The Ethernet MAC address is added multiple times into
478 the forwarding database and the vxlan device driver
479 sends a copy of the data packet to each entry found.
482 The arguments are the same as with
483 .BR "bridge fdb add" .
485 .SS bridge fdb delete - delete a forwarding database entry
486 This command removes an existing fdb entry.
489 The arguments are the same as with
490 .BR "bridge fdb add" .
492 .SS bridge fdb replace - replace a forwarding database entry
493 If no matching entry is found, a new one will be created instead.
496 The arguments are the same as with
497 .BR "bridge fdb add" .
499 .SS bridge fdb show - list forwarding entries.
501 This command displays the current forwarding table.
506 option, the command becomes verbose. It prints out the last updated
507 and last used time for each entry.
509 .SH bridge mdb - multicast group database management
512 objects contain known IP multicast group addresses on a link.
515 The corresponding commands display mdb entries, add new entries,
518 .SS bridge mdb add - add a new multicast group database entry
520 This command creates a new mdb entry.
524 the interface where this group address is associated.
528 the port whose link is known to have members of this multicast group.
532 the IP multicast group address whose members reside on the link connected to
536 - the mdb entry is permanent
540 - the mdb entry is temporary (default)
545 the VLAN ID which is known to have members of this multicast group.
548 .SS bridge mdb delete - delete a multicast group database entry
549 This command removes an existing mdb entry.
552 The arguments are the same as with
553 .BR "bridge mdb add" .
555 .SS bridge mdb show - list multicast group database entries
557 This command displays the current multicast group membership table. The table
558 is populated by IGMP and MLD snooping in the bridge driver automatically. It
563 commands manually too.
567 the interface only whose entries should be listed. Default is to list all
573 option, the command becomes verbose. It prints out the ports known to have
579 option, the command displays timer values for mdb and router port entries.
581 .SH bridge vlan - VLAN filter list
584 objects contain known VLAN IDs for a link.
587 The corresponding commands display vlan filter entries, add new entries,
590 .SS bridge vlan add - add a new vlan filter entry
592 This command creates a new vlan filter entry.
596 the interface with which this vlan is associated.
600 the VLAN ID that identifies the vlan.
603 .BI tunnel_info " TUNNEL_ID"
604 the TUNNEL ID that maps to this vlan. The tunnel id is set in dst_metadata for
605 every packet that belongs to this vlan (applicable to bridge ports with vlan_tunnel
610 the vlan specified is to be considered a PVID at ingress.
611 Any untagged frames will be assigned to this VLAN.
615 the vlan specified is to be treated as untagged on egress.
619 the vlan is configured on the specified physical device. Required if the
620 device is the bridge device.
624 the vlan is configured on the software bridge (default).
626 .SS bridge vlan delete - delete a vlan filter entry
627 This command removes an existing vlan filter entry.
630 The arguments are the same as with
631 .BR "bridge vlan add".
633 .BR "pvid " and " untagged"
636 .SS bridge vlan show - list vlan configuration.
638 This command displays the current VLAN filter table.
643 option, the command displays per-vlan traffic statistics.
645 .SS bridge vlan tunnelshow - list vlan tunnel mapping.
647 This command displays the current vlan tunnel info mapping.
649 .SH bridge monitor - state monitoring
653 utility can monitor the state of devices and addresses
654 continuously. This option has a slightly different format.
657 command is the first in the command line and then the object list follows:
659 .BR "bridge monitor" " [ " all " |"
663 is the list of object types that we want to monitor.
665 .BR link ", " fdb ", and " mdb "."
670 opens RTNETLINK, listens on it and dumps state changes in the format
671 described in previous sections.
674 If a file name is given, it does not listen on RTNETLINK,
675 but opens the file containing RTNETLINK messages saved in binary format
679 This command uses facilities added in Linux 3.0.
681 Although the forwarding table is maintained on a per-bridge device basis
682 the bridge device is not part of the syntax. This is a limitation of the
683 underlying netlink neighbour message protocol. When displaying the
684 forwarding table, entries for all bridges are displayed.
685 Add/delete/modify commands determine the underlying bridge device
686 based on the bridge to which the corresponding ethernet device is attached.
692 .RB "Please direct bugreports and patches to: " <netdev@vger.kernel.org>
695 Original Manpage by Stephen Hemminger