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 }
36 .BR guard " { " on " | " off " } ] [ "
37 .BR hairpin " { " on " | " off " } ] [ "
38 .BR fastleave " { " on " | " off " } ] [ "
39 .BR root_block " { " on " | " off " } ] [ "
40 .BR learning " { " on " | " off " } ] [ "
41 .BR learning_sync " { " on " | " off " } ] [ "
42 .BR flood " { " on " | " off " } ] [ "
43 .BR hwmode " { " vepa " | " veb " } ] [ "
44 .BR self " ] [ " master " ] "
47 .BR "bridge link" " [ " show " ] [ "
52 .BR "bridge fdb" " { " add " | " append " | " del " } "
56 .BR local " | " temp " } [ "
57 .BR self " ] [ " master " ] [ " router " ] [ " use " ] [ "
68 .BR "bridge fdb" " [ " show " ] [ "
73 .BR "bridge mdb" " { " add " | " del " } "
80 .BR permanent " | " temp " ]"
83 .BR "bridge mdb show " [ "
88 .BR "bridge vlan" " { " add " | " del " } "
93 .BR pvid " ] [ " untagged " ] [ "
94 .BR self " ] [ " master " ] "
97 .BR "bridge vlan" " [ " show " ] [ "
102 .BR "bridge monitor" " [ " all " | " neigh " | " link " | " mdb " ]"
107 .BR "\-V" , " -Version"
108 print the version of the
113 .BR "\-s" , " \-stats", " \-statistics"
114 output more information. If this option
115 is given multiple times, the amount of information increases.
116 As a rule, the information is statistics or some time values.
119 .BR "\-n" , " \-net" , " \-netns " <NETNS>
122 to the specified network namespace
124 Actually it just simplifies executing of:
129 .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
135 .RI "-n[etns] " NETNS " [ " OPTIONS " ] " OBJECT " { " COMMAND " | "
139 .SH BRIDGE - COMMAND SYNTAX
150 - Forwarding Database entry.
154 - Multicast group database entry.
163 Specifies the action to perform on the object.
164 The set of possible actions depends on the object type.
165 As a rule, it is possible to
166 .BR "add" , " delete"
171 ) objects, but some objects do not allow all of these operations
172 or have some additional commands. The
174 command is available for all objects. It prints
175 out a list of available commands and argument syntax conventions.
177 If no command is given, some default command is assumed.
180 or, if the objects of this class cannot be listed,
183 .SH bridge link - bridge port
186 objects correspond to the port devices of the bridge.
189 The corresponding commands set and display port status and bridge specific
192 .SS bridge link set - set bridge specific attributes on a port
196 interface name of the bridge port
200 the STP path cost of the specified port.
203 .BI priority " PRIO "
204 the STP port priority. The priority value is an unsigned 8-bit quantity
205 (number between 0 and 255). This metric is used in the designated port an
206 droot port selectio algorithms.
210 the operation state of the port. This is primarily used by user space STP/RSTP
211 implementation. One may enter a lowercased port state name, or one of the
212 numbers below. Negative inputs are ignored, and unrecognized names return an
216 - port is DISABLED. Make this port completely inactive.
220 - STP LISTENING state. Only valid if STP is enabled on the brige. In this
221 state the port for list for STP BPDUs and drop all other traffic.
225 - STP LEARNING state. Only valid if STP is enabled on the bridge. In this
226 state the port will accept traffic only for the purpose of updating MAC
231 - STP FORWARDING state. Port is fully active.
235 - STP BLOCKING state. Only valid if STP is enabled on the bridge. This state
236 is used during the STP election process. In this state, port will only process
241 .BR "guard on " or " guard off "
242 Controls whether STP BPUDs will be processed by the bridge port. By default,
243 the flag is turned off allowed BPDU processing. Turning this flag on will
244 cause the port to stop processing STP BPDUs.
247 .BR "hairpin on " or " hairpin off "
248 Controls whether traffic may be send back out of the port on which it was
249 received. By default, this flag is turned off and the bridge will not forward
250 traffic back out of the receiving port.
253 .BR "fastleave on " or " fastleave off "
254 This flag allows the bridge to immediately stop multicast traffic on a port
255 that receives IGMP Leave message. It is only used with IGMP snooping is
256 enabled on the bridge. By default the flag is off.
259 .BR "root_block on " or " root_block off "
260 Controls whether a given port is allowed to become root port or not. Only used
261 when STP is enabled on the bridge. By default the flag is off.
264 .BR "learning on " or " learning off "
265 Controls whether a given port will learn MAC addresses from received traffic or
266 not. If learning if off, the bridge will end up flooding any traffic for which
267 it has no FDB entry. By default this flag is on.
270 .BR "learning_sync on " or " learning_sync off "
271 Controls whether a given port will sync MAC addresses learned on device port to
275 .BR "flooding on " or " flooding off "
276 Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on.
280 Some network interface cards support HW bridge functionality and they may be
281 configured in different modes. Currently support modes are:
284 - Data sent between HW ports is sent on the wire to the external
288 - bridging happens in hardware.
292 link setting is configured on specified physical device
296 link setting is configured on the software bridge (default)
299 .SS bridge link show - list bridge port configuration.
301 This command displays the current bridge port configuration and flags.
303 .SH bridge fdb - forwarding database management
306 objects contain known Ethernet addresses on a link.
309 The corresponding commands display fdb entries, add new entries,
313 .SS bridge fdb add - add a new fdb entry
315 This command creates a new fdb entry.
319 the Ethernet MAC address.
323 the interface to which this address is associated.
326 - the address is associated with the port drivers fdb. Usually hardware.
330 - the address is associated with master devices fdb. Usually software (default).
334 - the destination address is associated with a router.
335 Valid if the referenced device is a VXLAN type device and has
336 route shortcircuit enabled.
340 - the address is in use. User space can use this option to
341 indicate to the kernel that the fdb entry is in use.
345 The next command line parameters apply only
346 when the specified device
351 the IP address of the destination
352 VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
356 the VXLAN VNI Network Identifier (or VXLAN Segment ID)
357 to use to connect to the remote VXLAN tunnel endpoint.
358 If omitted the value specified at vxlan device creation
363 the UDP destination PORT number to use to connect to the
364 remote VXLAN tunnel endpoint.
365 If omitted the default value is used.
369 device name of the outgoing interface for the
370 VXLAN device driver to reach the
371 remote VXLAN tunnel endpoint.
373 .SS bridge fdb append - append a forwarding database entry
374 This command adds a new fdb entry with an already known
376 Valid only for multicast link layer addresses.
377 The command adds support for broadcast and multicast
378 Ethernet MAC addresses.
379 The Ethernet MAC address is added multiple times into
380 the forwarding database and the vxlan device driver
381 sends a copy of the data packet to each entry found.
384 The arguments are the same as with
385 .BR "bridge fdb add" ,
387 .SS bridge fdb delete - delete a forwarding database entry
388 This command removes an existing fdb entry.
391 The arguments are the same as with
392 .BR "bridge fdb add" ,
394 .SS bridge fdb show - list forwarding entries.
396 This command displays the current forwarding table.
401 option, the command becomes verbose. It prints out the last updated
402 and last used time for each entry.
404 .SH bridge mdb - multicast group database management
407 objects contain known IP multicast group addresses on a link.
410 The corresponding commands display mdb entries, add new entries,
413 .SS bridge mdb add - add a new multicast group database entry
415 This command creates a new mdb entry.
419 the interface where this group address is associated.
423 the port whose link is known to have members of this multicast group.
427 the IP multicast group address whose members reside on the link connected to
431 - the mdb entry is permanent
435 - the mdb entry is temporary (default)
439 .SS bridge mdb delete - delete a multicast group database entry
440 This command removes an existing mdb entry.
443 The arguments are the same as with
444 .BR "bridge mdb add" .
446 .SS bridge mdb show - list multicast group database entries
448 This command displays the current multicast group membership table. The table
449 is populated by IGMP and MLD snooping in the bridge driver automatically. It
454 commands manually too.
458 the interface only whose entries should be listed. Default is to list all
464 option, the command becomes verbose. It prints out the ports known to have
467 .SH bridge vlan - VLAN filter list
470 objects contain known VLAN IDs for a link.
473 The corresponding commands display vlan filter entries, add new entries,
476 .SS bridge vlan add - add a new vlan filter entry
478 This command creates a new vlan filter entry.
482 the interface with which this vlan is associated.
486 the VLAN ID that identifies the vlan.
490 the vlan specified is to be considered a PVID at ingress.
491 Any untagged frames will be assigned to this VLAN.
495 the vlan specified is to be treated as untagged on egress.
499 the vlan is configured on the specified physical device. Required if the
500 device is the bridge device.
504 the vlan is configured on the software bridge (default).
506 .SS bridge vlan delete - delete a forwarding database entry
507 This command removes an existing fdb entry.
510 The arguments are the same as with
511 .BR "bridge vlan add".
513 .BR "pvid " and " untagged"
516 .SS bridge vlan show - list vlan configuration.
518 This command displays the current VLAN filter table.
520 .SH bridge monitor - state monitoring
524 utility can monitor the state of devices and addresses
525 continuously. This option has a slightly different format.
528 command is the first in the command line and then the object list follows:
530 .BR "bridge monitor" " [ " all " |"
534 is the list of object types that we want to monitor.
536 .BR link ", " fdb ", and " mdb "."
541 opens RTNETLINK, listens on it and dumps state changes in the format
542 described in previous sections.
545 If a file name is given, it does not listen on RTNETLINK,
546 but opens the file containing RTNETLINK messages saved in binary format
550 This command uses facilities added in Linux 3.0.
552 Although the forwarding table is maintained on a per-bridge device basis
553 the bridge device is not part of the syntax. This is a limitation of the
554 underlying netlink neighbour message protocol. When displaying the
555 forwarding table, entries for all bridges are displayed.
556 Add/delete/modify commands determine the underlying bridge device
557 based on the bridge to which the corresponding ethernet device is attached.
563 .RB "Please direct bugreports and patches to: " <netdev@vger.kernel.org>
566 Original Manpage by Stephen Hemminger