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\-j\fR[\fIson\fR] }
38 .BR guard " { " on " | " off " } ] [ "
39 .BR hairpin " { " on " | " off " } ] [ "
40 .BR fastleave " { " on " | " off " } ] [ "
41 .BR root_block " { " on " | " off " } ] [ "
42 .BR learning " { " on " | " off " } ] [ "
43 .BR learning_sync " { " on " | " off " } ] [ "
44 .BR flood " { " on " | " off " } ] [ "
45 .BR hwmode " { " vepa " | " veb " } ] [ "
46 .BR mcast_flood " { " on " | " off " } ] [ "
47 .BR self " ] [ " master " ]"
50 .BR "bridge link" " [ " show " ] [ "
55 .BR "bridge fdb" " { " add " | " append " | " del " | " replace " } "
59 .BR local " | " static " | " dynamic " } [ "
60 .BR self " ] [ " master " ] [ " router " ] [ " use " ] [ "
71 .BR "bridge fdb" " [ " show " ] [ "
84 .BR "bridge mdb" " { " add " | " del " } "
91 .BR permanent " | " temp " ] [ "
96 .BR "bridge mdb show " [ "
101 .BR "bridge vlan" " { " add " | " del " } "
106 .BR pvid " ] [ " untagged " ] [ "
107 .BR self " ] [ " master " ] "
110 .BR "bridge vlan" " [ " show " ] [ "
115 .BR "bridge monitor" " [ " all " | " neigh " | " link " | " mdb " ]"
120 .BR "\-V" , " -Version"
121 print the version of the
126 .BR "\-s" , " \-stats", " \-statistics"
127 output more information. If this option
128 is given multiple times, the amount of information increases.
129 As a rule, the information is statistics or some time values.
132 .BR "\-d" , " \-details"
133 print detailed information about MDB router ports.
136 .BR "\-n" , " \-net" , " \-netns " <NETNS>
139 to the specified network namespace
141 Actually it just simplifies executing of:
146 .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
152 .RI "-n[etns] " NETNS " [ " OPTIONS " ] " OBJECT " { " COMMAND " | "
156 .BR "\-b", " \-batch " <FILENAME>
157 Read commands from provided file or standard input and invoke them.
158 First failure will cause termination of bridge command.
162 Don't terminate bridge command on errors in batch mode.
163 If there were any errors during execution of the commands, the application
164 return code will be non zero.
168 Display results in JSON format. Currently available for vlan and fdb.
170 .SH BRIDGE - COMMAND SYNTAX
181 - Forwarding Database entry.
185 - Multicast group database entry.
194 Specifies the action to perform on the object.
195 The set of possible actions depends on the object type.
196 As a rule, it is possible to
197 .BR "add" , " delete"
202 ) objects, but some objects do not allow all of these operations
203 or have some additional commands. The
205 command is available for all objects. It prints
206 out a list of available commands and argument syntax conventions.
208 If no command is given, some default command is assumed.
211 or, if the objects of this class cannot be listed,
214 .SH bridge link - bridge port
217 objects correspond to the port devices of the bridge.
220 The corresponding commands set and display port status and bridge specific
223 .SS bridge link set - set bridge specific attributes on a port
227 interface name of the bridge port
231 the STP path cost of the specified port.
234 .BI priority " PRIO "
235 the STP port priority. The priority value is an unsigned 8-bit quantity
236 (number between 0 and 255). This metric is used in the designated port an
237 droot port selectio algorithms.
241 the operation state of the port. This is primarily used by user space STP/RSTP
242 implementation. One may enter a lowercased port state name, or one of the
243 numbers below. Negative inputs are ignored, and unrecognized names return an
247 - port is DISABLED. Make this port completely inactive.
251 - STP LISTENING state. Only valid if STP is enabled on the bridge. In this
252 state the port listens for STP BPDUs and drops all other traffic frames.
256 - STP LEARNING state. Only valid if STP is enabled on the bridge. In this
257 state the port will accept traffic only for the purpose of updating MAC
262 - STP FORWARDING state. Port is fully active.
266 - STP BLOCKING state. Only valid if STP is enabled on the bridge. This state
267 is used during the STP election process. In this state, port will only process
272 .BR "guard on " or " guard off "
273 Controls whether STP BPDUs will be processed by the bridge port. By default,
274 the flag is turned off allowed BPDU processing. Turning this flag on will
275 cause the port to stop processing STP BPDUs.
278 .BR "hairpin on " or " hairpin off "
279 Controls whether traffic may be send back out of the port on which it was
280 received. By default, this flag is turned off and the bridge will not forward
281 traffic back out of the receiving port.
284 .BR "fastleave on " or " fastleave off "
285 This flag allows the bridge to immediately stop multicast traffic on a port
286 that receives IGMP Leave message. It is only used with IGMP snooping is
287 enabled on the bridge. By default the flag is off.
290 .BR "root_block on " or " root_block off "
291 Controls whether a given port is allowed to become root port or not. Only used
292 when STP is enabled on the bridge. By default the flag is off.
295 .BR "learning on " or " learning off "
296 Controls whether a given port will learn MAC addresses from received traffic or
297 not. If learning if off, the bridge will end up flooding any traffic for which
298 it has no FDB entry. By default this flag is on.
301 .BR "learning_sync on " or " learning_sync off "
302 Controls whether a given port will sync MAC addresses learned on device port to
306 .BR "flooding on " or " flooding off "
307 Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on.
311 Some network interface cards support HW bridge functionality and they may be
312 configured in different modes. Currently support modes are:
315 - Data sent between HW ports is sent on the wire to the external
319 - bridging happens in hardware.
322 .BR "mcast_flood on " or " mcast_flood off "
323 Controls whether a given port will be flooded with multicast traffic for which there is no MDB entry. By default this flag is on.
326 .BR "neigh_suppress on " or " neigh_suppress off "
327 Controls whether neigh discovery (arp and nd) proxy and suppression is enabled on the port. By default this flag is off.
331 link setting is configured on specified physical device
335 link setting is configured on the software bridge (default)
338 .BR "\-t" , " \-timestamp"
339 display current time when using monitor option.
341 .SS bridge link show - list bridge port configuration.
343 This command displays the current bridge port configuration and flags.
345 .SH bridge fdb - forwarding database management
348 objects contain known Ethernet addresses on a link.
351 The corresponding commands display fdb entries, add new entries,
355 .SS bridge fdb add - add a new fdb entry
357 This command creates a new fdb entry.
361 the Ethernet MAC address.
365 the interface to which this address is associated.
368 - is a local permanent fdb entry
372 - is a static (no arp) fdb entry
376 - is a dynamic reachable age-able fdb entry
380 - the address is associated with the port drivers fdb. Usually hardware.
384 - the address is associated with master devices fdb. Usually software (default).
388 - the destination address is associated with a router.
389 Valid if the referenced device is a VXLAN type device and has
390 route shortcircuit enabled.
394 - the address is in use. User space can use this option to
395 indicate to the kernel that the fdb entry is in use.
399 The next command line parameters apply only
400 when the specified device
405 the IP address of the destination
406 VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
410 the VXLAN VNI Network Identifier (or VXLAN Segment ID)
411 to use to connect to the remote VXLAN tunnel endpoint.
412 If omitted the value specified at vxlan device creation
417 the UDP destination PORT number to use to connect to the
418 remote VXLAN tunnel endpoint.
419 If omitted the default value is used.
423 device name of the outgoing interface for the
424 VXLAN device driver to reach the
425 remote VXLAN tunnel endpoint.
427 .SS bridge fdb append - append a forwarding database entry
428 This command adds a new fdb entry with an already known
430 Valid only for multicast link layer addresses.
431 The command adds support for broadcast and multicast
432 Ethernet MAC addresses.
433 The Ethernet MAC address is added multiple times into
434 the forwarding database and the vxlan device driver
435 sends a copy of the data packet to each entry found.
438 The arguments are the same as with
439 .BR "bridge fdb add" .
441 .SS bridge fdb delete - delete a forwarding database entry
442 This command removes an existing fdb entry.
445 The arguments are the same as with
446 .BR "bridge fdb add" .
448 .SS bridge fdb replace - replace a forwarding database entry
449 If no matching entry is found, a new one will be created instead.
452 The arguments are the same as with
453 .BR "bridge fdb add" .
455 .SS bridge fdb show - list forwarding entries.
457 This command displays the current forwarding table.
462 option, the command becomes verbose. It prints out the last updated
463 and last used time for each entry.
465 .SH bridge mdb - multicast group database management
468 objects contain known IP multicast group addresses on a link.
471 The corresponding commands display mdb entries, add new entries,
474 .SS bridge mdb add - add a new multicast group database entry
476 This command creates a new mdb entry.
480 the interface where this group address is associated.
484 the port whose link is known to have members of this multicast group.
488 the IP multicast group address whose members reside on the link connected to
492 - the mdb entry is permanent
496 - the mdb entry is temporary (default)
501 the VLAN ID which is known to have members of this multicast group.
504 .SS bridge mdb delete - delete a multicast group database entry
505 This command removes an existing mdb entry.
508 The arguments are the same as with
509 .BR "bridge mdb add" .
511 .SS bridge mdb show - list multicast group database entries
513 This command displays the current multicast group membership table. The table
514 is populated by IGMP and MLD snooping in the bridge driver automatically. It
519 commands manually too.
523 the interface only whose entries should be listed. Default is to list all
529 option, the command becomes verbose. It prints out the ports known to have
535 option, the command displays timer values for mdb and router port entries.
537 .SH bridge vlan - VLAN filter list
540 objects contain known VLAN IDs for a link.
543 The corresponding commands display vlan filter entries, add new entries,
546 .SS bridge vlan add - add a new vlan filter entry
548 This command creates a new vlan filter entry.
552 the interface with which this vlan is associated.
556 the VLAN ID that identifies the vlan.
560 the vlan specified is to be considered a PVID at ingress.
561 Any untagged frames will be assigned to this VLAN.
565 the vlan specified is to be treated as untagged on egress.
569 the vlan is configured on the specified physical device. Required if the
570 device is the bridge device.
574 the vlan is configured on the software bridge (default).
576 .SS bridge vlan delete - delete a vlan filter entry
577 This command removes an existing vlan filter entry.
580 The arguments are the same as with
581 .BR "bridge vlan add".
583 .BR "pvid " and " untagged"
586 .SS bridge vlan show - list vlan configuration.
588 This command displays the current VLAN filter table.
593 option, the command displays per-vlan traffic statistics.
595 .SH bridge monitor - state monitoring
599 utility can monitor the state of devices and addresses
600 continuously. This option has a slightly different format.
603 command is the first in the command line and then the object list follows:
605 .BR "bridge monitor" " [ " all " |"
609 is the list of object types that we want to monitor.
611 .BR link ", " fdb ", and " mdb "."
616 opens RTNETLINK, listens on it and dumps state changes in the format
617 described in previous sections.
620 If a file name is given, it does not listen on RTNETLINK,
621 but opens the file containing RTNETLINK messages saved in binary format
625 This command uses facilities added in Linux 3.0.
627 Although the forwarding table is maintained on a per-bridge device basis
628 the bridge device is not part of the syntax. This is a limitation of the
629 underlying netlink neighbour message protocol. When displaying the
630 forwarding table, entries for all bridges are displayed.
631 Add/delete/modify commands determine the underlying bridge device
632 based on the bridge to which the corresponding ethernet device is attached.
638 .RB "Please direct bugreports and patches to: " <netdev@vger.kernel.org>
641 Original Manpage by Stephen Hemminger