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 " } ] [ "
55 .BR nobackup_port " ] [ "
56 .BR self " ] [ " master " ]"
59 .BR "bridge link" " [ " show " ] [ "
64 .BR "bridge fdb" " { " add " | " append " | " del " | " replace " } "
68 .BR local " | " static " | " dynamic " } [ "
69 .BR self " ] [ " master " ] [ " router " ] [ " use " ] [ " extern_learn " ] [ " sticky " ] [ "
80 .BR "bridge fdb" " [ " show " ] [ "
93 .BR "bridge mdb" " { " add " | " del " } "
100 .BR permanent " | " temp " ] [ "
105 .BR "bridge mdb show " [ "
110 .BR "bridge vlan" " { " add " | " del " } "
116 .IR TUNNEL_ID " ] [ "
117 .BR pvid " ] [ " untagged " ] [ "
118 .BR self " ] [ " master " ] "
121 .BR "bridge vlan" " [ " show " | " tunnelshow " ] [ "
126 .BR "bridge monitor" " [ " all " | " neigh " | " link " | " mdb " ]"
131 .BR "\-V" , " -Version"
132 print the version of the
137 .BR "\-s" , " \-stats", " \-statistics"
138 output more information. If this option
139 is given multiple times, the amount of information increases.
140 As a rule, the information is statistics or some time values.
143 .BR "\-d" , " \-details"
144 print detailed information about MDB router ports.
147 .BR "\-n" , " \-net" , " \-netns " <NETNS>
150 to the specified network namespace
152 Actually it just simplifies executing of:
157 .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
163 .RI "-n[etns] " NETNS " [ " OPTIONS " ] " OBJECT " { " COMMAND " | "
167 .BR "\-b", " \-batch " <FILENAME>
168 Read commands from provided file or standard input and invoke them.
169 First failure will cause termination of bridge command.
173 Don't terminate bridge command on errors in batch mode.
174 If there were any errors during execution of the commands, the application
175 return code will be non zero.
178 .BR \-c [ color ][ = { always | auto | never }
179 Configure color output. If parameter is omitted or
181 color output is enabled regardless of stdout state. If parameter is
183 stdout is checked to be a terminal before enabling color output. If parameter is
185 color output is disabled. If specified multiple times, the last one takes
186 precedence. This flag is ignored if
192 Output results in JavaScript Object Notation (JSON).
195 .BR "\-p", " \-pretty"
196 When combined with -j generate a pretty JSON output.
199 .BR "\-o", " \-oneline"
200 output each record on a single line, replacing line feeds
203 character. This is convenient when you want to count records
211 .SH BRIDGE - COMMAND SYNTAX
222 - Forwarding Database entry.
226 - Multicast group database entry.
235 Specifies the action to perform on the object.
236 The set of possible actions depends on the object type.
237 As a rule, it is possible to
238 .BR "add" , " delete"
243 ) objects, but some objects do not allow all of these operations
244 or have some additional commands. The
246 command is available for all objects. It prints
247 out a list of available commands and argument syntax conventions.
249 If no command is given, some default command is assumed.
252 or, if the objects of this class cannot be listed,
255 .SH bridge link - bridge port
258 objects correspond to the port devices of the bridge.
261 The corresponding commands set and display port status and bridge specific
264 .SS bridge link set - set bridge specific attributes on a port
268 interface name of the bridge port
272 the STP path cost of the specified port.
275 .BI priority " PRIO "
276 the STP port priority. The priority value is an unsigned 8-bit quantity
277 (number between 0 and 255). This metric is used in the designated port an
278 droot port selectio algorithms.
282 the operation state of the port. This is primarily used by user space STP/RSTP
283 implementation. One may enter a lowercased port state name, or one of the
284 numbers below. Negative inputs are ignored, and unrecognized names return an
288 - port is DISABLED. Make this port completely inactive.
292 - STP LISTENING state. Only valid if STP is enabled on the bridge. In this
293 state the port listens for STP BPDUs and drops all other traffic frames.
297 - STP LEARNING state. Only valid if STP is enabled on the bridge. In this
298 state the port will accept traffic only for the purpose of updating MAC
303 - STP FORWARDING state. Port is fully active.
307 - STP BLOCKING state. Only valid if STP is enabled on the bridge. This state
308 is used during the STP election process. In this state, port will only process
313 .BR "guard on " or " guard off "
314 Controls whether STP BPDUs will be processed by the bridge port. By default,
315 the flag is turned off allowed BPDU processing. Turning this flag on will
316 cause the port to stop processing STP BPDUs.
319 .BR "hairpin on " or " hairpin off "
320 Controls whether traffic may be send back out of the port on which it was
321 received. By default, this flag is turned off and the bridge will not forward
322 traffic back out of the receiving port.
325 .BR "fastleave on " or " fastleave off "
326 This flag allows the bridge to immediately stop multicast traffic on a port
327 that receives IGMP Leave message. It is only used with IGMP snooping is
328 enabled on the bridge. By default the flag is off.
331 .BR "root_block on " or " root_block off "
332 Controls whether a given port is allowed to become root port or not. Only used
333 when STP is enabled on the bridge. By default the flag is off.
336 .BR "learning on " or " learning off "
337 Controls whether a given port will learn MAC addresses from received traffic or
338 not. If learning if off, the bridge will end up flooding any traffic for which
339 it has no FDB entry. By default this flag is on.
342 .BR "learning_sync on " or " learning_sync off "
343 Controls whether a given port will sync MAC addresses learned on device port to
347 .BR "flood on " or " flood off "
348 Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on.
352 Some network interface cards support HW bridge functionality and they may be
353 configured in different modes. Currently support modes are:
356 - Data sent between HW ports is sent on the wire to the external
360 - bridging happens in hardware.
363 .BR "mcast_flood on " or " mcast_flood off "
364 Controls whether a given port will flood multicast traffic for which there is no MDB entry. By default this flag is on.
367 .BR "neigh_suppress on " or " neigh_suppress off "
368 Controls whether neigh discovery (arp and nd) proxy and suppression is enabled on the port. By default this flag is off.
371 .BR "vlan_tunnel on " or " vlan_tunnel off "
372 Controls whether vlan to tunnel mapping is enabled on the port. By default this flag is off.
375 .BR "isolated on " or " isolated off "
376 Controls whether a given port will be isolated, which means it will be able to communicate with non-isolated ports only.
377 By default this flag is off.
380 .BI backup_port " DEVICE"
381 If the port loses carrier all traffic will be redirected to the configured backup port
385 Removes the currently configured backup port
389 link setting is configured on specified physical device
393 link setting is configured on the software bridge (default)
396 .BR "\-t" , " \-timestamp"
397 display current time when using monitor option.
399 .SS bridge link show - list bridge port configuration.
401 This command displays the current bridge port configuration and flags.
403 .SH bridge fdb - forwarding database management
406 objects contain known Ethernet addresses on a link.
409 The corresponding commands display fdb entries, add new entries,
413 .SS bridge fdb add - add a new fdb entry
415 This command creates a new fdb entry.
419 the Ethernet MAC address.
423 the interface to which this address is associated.
426 - is a local permanent fdb entry
430 - is a static (no arp) fdb entry
434 - is a dynamic reachable age-able fdb entry
438 - the address is associated with the port drivers fdb. Usually hardware.
442 - the address is associated with master devices fdb. Usually software (default).
446 - the destination address is associated with a router.
447 Valid if the referenced device is a VXLAN type device and has
448 route shortcircuit enabled.
452 - the address is in use. User space can use this option to
453 indicate to the kernel that the fdb entry is in use.
457 - this entry was learned externally. This option can be used to
458 indicate to the kernel that an entry was hardware or user-space
459 controller learnt dynamic entry. Kernel will not age such an entry.
463 - this entry will not change its port due to learning.
467 The next command line parameters apply only
468 when the specified device
473 the IP address of the destination
474 VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
478 the VXLAN VNI Network Identifier (or VXLAN Segment ID)
479 to use to connect to the remote VXLAN tunnel endpoint.
480 If omitted the value specified at vxlan device creation
485 the UDP destination PORT number to use to connect to the
486 remote VXLAN tunnel endpoint.
487 If omitted the default value is used.
491 device name of the outgoing interface for the
492 VXLAN device driver to reach the
493 remote VXLAN tunnel endpoint.
495 .SS bridge fdb append - append a forwarding database entry
496 This command adds a new fdb entry with an already known
498 Valid only for multicast link layer addresses.
499 The command adds support for broadcast and multicast
500 Ethernet MAC addresses.
501 The Ethernet MAC address is added multiple times into
502 the forwarding database and the vxlan device driver
503 sends a copy of the data packet to each entry found.
506 The arguments are the same as with
507 .BR "bridge fdb add" .
509 .SS bridge fdb delete - delete a forwarding database entry
510 This command removes an existing fdb entry.
513 The arguments are the same as with
514 .BR "bridge fdb add" .
516 .SS bridge fdb replace - replace a forwarding database entry
517 If no matching entry is found, a new one will be created instead.
520 The arguments are the same as with
521 .BR "bridge fdb add" .
523 .SS bridge fdb show - list forwarding entries.
525 This command displays the current forwarding table.
530 option, the command becomes verbose. It prints out the last updated
531 and last used time for each entry.
533 .SH bridge mdb - multicast group database management
536 objects contain known IP multicast group addresses on a link.
539 The corresponding commands display mdb entries, add new entries,
542 .SS bridge mdb add - add a new multicast group database entry
544 This command creates a new mdb entry.
548 the interface where this group address is associated.
552 the port whose link is known to have members of this multicast group.
556 the IP multicast group address whose members reside on the link connected to
560 - the mdb entry is permanent
564 - the mdb entry is temporary (default)
569 the VLAN ID which is known to have members of this multicast group.
572 .SS bridge mdb delete - delete a multicast group database entry
573 This command removes an existing mdb entry.
576 The arguments are the same as with
577 .BR "bridge mdb add" .
579 .SS bridge mdb show - list multicast group database entries
581 This command displays the current multicast group membership table. The table
582 is populated by IGMP and MLD snooping in the bridge driver automatically. It
587 commands manually too.
591 the interface only whose entries should be listed. Default is to list all
597 option, the command becomes verbose. It prints out the ports known to have
603 option, the command displays timer values for mdb and router port entries.
605 .SH bridge vlan - VLAN filter list
608 objects contain known VLAN IDs for a link.
611 The corresponding commands display vlan filter entries, add new entries,
614 .SS bridge vlan add - add a new vlan filter entry
616 This command creates a new vlan filter entry.
620 the interface with which this vlan is associated.
624 the VLAN ID that identifies the vlan.
627 .BI tunnel_info " TUNNEL_ID"
628 the TUNNEL ID that maps to this vlan. The tunnel id is set in dst_metadata for
629 every packet that belongs to this vlan (applicable to bridge ports with vlan_tunnel
634 the vlan specified is to be considered a PVID at ingress.
635 Any untagged frames will be assigned to this VLAN.
639 the vlan specified is to be treated as untagged on egress.
643 the vlan is configured on the specified physical device. Required if the
644 device is the bridge device.
648 the vlan is configured on the software bridge (default).
650 .SS bridge vlan delete - delete a vlan filter entry
651 This command removes an existing vlan filter entry.
654 The arguments are the same as with
655 .BR "bridge vlan add".
657 .BR "pvid " and " untagged"
660 .SS bridge vlan show - list vlan configuration.
662 This command displays the current VLAN filter table.
667 option, the command displays per-vlan traffic statistics.
669 .SS bridge vlan tunnelshow - list vlan tunnel mapping.
671 This command displays the current vlan tunnel info mapping.
673 .SH bridge monitor - state monitoring
677 utility can monitor the state of devices and addresses
678 continuously. This option has a slightly different format.
681 command is the first in the command line and then the object list follows:
683 .BR "bridge monitor" " [ " all " |"
687 is the list of object types that we want to monitor.
689 .BR link ", " fdb ", and " mdb "."
694 opens RTNETLINK, listens on it and dumps state changes in the format
695 described in previous sections.
698 If a file name is given, it does not listen on RTNETLINK,
699 but opens the file containing RTNETLINK messages saved in binary format
703 This command uses facilities added in Linux 3.0.
705 Although the forwarding table is maintained on a per-bridge device basis
706 the bridge device is not part of the syntax. This is a limitation of the
707 underlying netlink neighbour message protocol. When displaying the
708 forwarding table, entries for all bridges are displayed.
709 Add/delete/modify commands determine the underlying bridge device
710 based on the bridge to which the corresponding ethernet device is attached.
716 .RB "Please direct bugreports and patches to: " <netdev@vger.kernel.org>
719 Original Manpage by Stephen Hemminger