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 ][ = { always | auto | never }
176 Configure color output. If parameter is omitted or
178 color output is enabled regardless of stdout state. If parameter is
180 stdout is checked to be a terminal before enabling color output. If parameter is
182 color output is disabled. If specified multiple times, the last one takes
183 precedence. This flag is ignored if
189 Output results in JavaScript Object Notation (JSON).
192 .BR "\-p", " \-pretty"
193 When combined with -j generate a pretty JSON output.
196 .BR "\-o", " \-oneline"
197 output each record on a single line, replacing line feeds
200 character. This is convenient when you want to count records
208 .SH BRIDGE - COMMAND SYNTAX
219 - Forwarding Database entry.
223 - Multicast group database entry.
232 Specifies the action to perform on the object.
233 The set of possible actions depends on the object type.
234 As a rule, it is possible to
235 .BR "add" , " delete"
240 ) objects, but some objects do not allow all of these operations
241 or have some additional commands. The
243 command is available for all objects. It prints
244 out a list of available commands and argument syntax conventions.
246 If no command is given, some default command is assumed.
249 or, if the objects of this class cannot be listed,
252 .SH bridge link - bridge port
255 objects correspond to the port devices of the bridge.
258 The corresponding commands set and display port status and bridge specific
261 .SS bridge link set - set bridge specific attributes on a port
265 interface name of the bridge port
269 the STP path cost of the specified port.
272 .BI priority " PRIO "
273 the STP port priority. The priority value is an unsigned 8-bit quantity
274 (number between 0 and 255). This metric is used in the designated port an
275 droot port selectio algorithms.
279 the operation state of the port. This is primarily used by user space STP/RSTP
280 implementation. One may enter a lowercased port state name, or one of the
281 numbers below. Negative inputs are ignored, and unrecognized names return an
285 - port is DISABLED. Make this port completely inactive.
289 - STP LISTENING state. Only valid if STP is enabled on the bridge. In this
290 state the port listens for STP BPDUs and drops all other traffic frames.
294 - STP LEARNING state. Only valid if STP is enabled on the bridge. In this
295 state the port will accept traffic only for the purpose of updating MAC
300 - STP FORWARDING state. Port is fully active.
304 - STP BLOCKING state. Only valid if STP is enabled on the bridge. This state
305 is used during the STP election process. In this state, port will only process
310 .BR "guard on " or " guard off "
311 Controls whether STP BPDUs will be processed by the bridge port. By default,
312 the flag is turned off allowed BPDU processing. Turning this flag on will
313 cause the port to stop processing STP BPDUs.
316 .BR "hairpin on " or " hairpin off "
317 Controls whether traffic may be send back out of the port on which it was
318 received. By default, this flag is turned off and the bridge will not forward
319 traffic back out of the receiving port.
322 .BR "fastleave on " or " fastleave off "
323 This flag allows the bridge to immediately stop multicast traffic on a port
324 that receives IGMP Leave message. It is only used with IGMP snooping is
325 enabled on the bridge. By default the flag is off.
328 .BR "root_block on " or " root_block off "
329 Controls whether a given port is allowed to become root port or not. Only used
330 when STP is enabled on the bridge. By default the flag is off.
333 .BR "learning on " or " learning off "
334 Controls whether a given port will learn MAC addresses from received traffic or
335 not. If learning if off, the bridge will end up flooding any traffic for which
336 it has no FDB entry. By default this flag is on.
339 .BR "learning_sync on " or " learning_sync off "
340 Controls whether a given port will sync MAC addresses learned on device port to
344 .BR "flooding on " or " flooding off "
345 Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on.
349 Some network interface cards support HW bridge functionality and they may be
350 configured in different modes. Currently support modes are:
353 - Data sent between HW ports is sent on the wire to the external
357 - bridging happens in hardware.
360 .BR "mcast_flood on " or " mcast_flood off "
361 Controls whether a given port will be flooded with multicast traffic for which there is no MDB entry. By default this flag is on.
364 .BR "neigh_suppress on " or " neigh_suppress off "
365 Controls whether neigh discovery (arp and nd) proxy and suppression is enabled on the port. By default this flag is off.
368 .BR "vlan_tunnel on " or " vlan_tunnel off "
369 Controls whether vlan to tunnel mapping is enabled on the port. By default this flag is off.
372 .BR "isolated on " or " isolated off "
373 Controls whether a given port will be isolated, which means it will be able to communicate with non-isolated ports only.
374 By default this flag is off.
378 link setting is configured on specified physical device
382 link setting is configured on the software bridge (default)
385 .BR "\-t" , " \-timestamp"
386 display current time when using monitor option.
388 .SS bridge link show - list bridge port configuration.
390 This command displays the current bridge port configuration and flags.
392 .SH bridge fdb - forwarding database management
395 objects contain known Ethernet addresses on a link.
398 The corresponding commands display fdb entries, add new entries,
402 .SS bridge fdb add - add a new fdb entry
404 This command creates a new fdb entry.
408 the Ethernet MAC address.
412 the interface to which this address is associated.
415 - is a local permanent fdb entry
419 - is a static (no arp) fdb entry
423 - is a dynamic reachable age-able fdb entry
427 - the address is associated with the port drivers fdb. Usually hardware.
431 - the address is associated with master devices fdb. Usually software (default).
435 - the destination address is associated with a router.
436 Valid if the referenced device is a VXLAN type device and has
437 route shortcircuit enabled.
441 - the address is in use. User space can use this option to
442 indicate to the kernel that the fdb entry is in use.
446 - this entry was learned externally. This option can be used to
447 indicate to the kernel that an entry was hardware or user-space
448 controller learnt dynamic entry. Kernel will not age such an entry.
452 The next command line parameters apply only
453 when the specified device
458 the IP address of the destination
459 VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
463 the VXLAN VNI Network Identifier (or VXLAN Segment ID)
464 to use to connect to the remote VXLAN tunnel endpoint.
465 If omitted the value specified at vxlan device creation
470 the UDP destination PORT number to use to connect to the
471 remote VXLAN tunnel endpoint.
472 If omitted the default value is used.
476 device name of the outgoing interface for the
477 VXLAN device driver to reach the
478 remote VXLAN tunnel endpoint.
480 .SS bridge fdb append - append a forwarding database entry
481 This command adds a new fdb entry with an already known
483 Valid only for multicast link layer addresses.
484 The command adds support for broadcast and multicast
485 Ethernet MAC addresses.
486 The Ethernet MAC address is added multiple times into
487 the forwarding database and the vxlan device driver
488 sends a copy of the data packet to each entry found.
491 The arguments are the same as with
492 .BR "bridge fdb add" .
494 .SS bridge fdb delete - delete a forwarding database entry
495 This command removes an existing fdb entry.
498 The arguments are the same as with
499 .BR "bridge fdb add" .
501 .SS bridge fdb replace - replace a forwarding database entry
502 If no matching entry is found, a new one will be created instead.
505 The arguments are the same as with
506 .BR "bridge fdb add" .
508 .SS bridge fdb show - list forwarding entries.
510 This command displays the current forwarding table.
515 option, the command becomes verbose. It prints out the last updated
516 and last used time for each entry.
518 .SH bridge mdb - multicast group database management
521 objects contain known IP multicast group addresses on a link.
524 The corresponding commands display mdb entries, add new entries,
527 .SS bridge mdb add - add a new multicast group database entry
529 This command creates a new mdb entry.
533 the interface where this group address is associated.
537 the port whose link is known to have members of this multicast group.
541 the IP multicast group address whose members reside on the link connected to
545 - the mdb entry is permanent
549 - the mdb entry is temporary (default)
554 the VLAN ID which is known to have members of this multicast group.
557 .SS bridge mdb delete - delete a multicast group database entry
558 This command removes an existing mdb entry.
561 The arguments are the same as with
562 .BR "bridge mdb add" .
564 .SS bridge mdb show - list multicast group database entries
566 This command displays the current multicast group membership table. The table
567 is populated by IGMP and MLD snooping in the bridge driver automatically. It
572 commands manually too.
576 the interface only whose entries should be listed. Default is to list all
582 option, the command becomes verbose. It prints out the ports known to have
588 option, the command displays timer values for mdb and router port entries.
590 .SH bridge vlan - VLAN filter list
593 objects contain known VLAN IDs for a link.
596 The corresponding commands display vlan filter entries, add new entries,
599 .SS bridge vlan add - add a new vlan filter entry
601 This command creates a new vlan filter entry.
605 the interface with which this vlan is associated.
609 the VLAN ID that identifies the vlan.
612 .BI tunnel_info " TUNNEL_ID"
613 the TUNNEL ID that maps to this vlan. The tunnel id is set in dst_metadata for
614 every packet that belongs to this vlan (applicable to bridge ports with vlan_tunnel
619 the vlan specified is to be considered a PVID at ingress.
620 Any untagged frames will be assigned to this VLAN.
624 the vlan specified is to be treated as untagged on egress.
628 the vlan is configured on the specified physical device. Required if the
629 device is the bridge device.
633 the vlan is configured on the software bridge (default).
635 .SS bridge vlan delete - delete a vlan filter entry
636 This command removes an existing vlan filter entry.
639 The arguments are the same as with
640 .BR "bridge vlan add".
642 .BR "pvid " and " untagged"
645 .SS bridge vlan show - list vlan configuration.
647 This command displays the current VLAN filter table.
652 option, the command displays per-vlan traffic statistics.
654 .SS bridge vlan tunnelshow - list vlan tunnel mapping.
656 This command displays the current vlan tunnel info mapping.
658 .SH bridge monitor - state monitoring
662 utility can monitor the state of devices and addresses
663 continuously. This option has a slightly different format.
666 command is the first in the command line and then the object list follows:
668 .BR "bridge monitor" " [ " all " |"
672 is the list of object types that we want to monitor.
674 .BR link ", " fdb ", and " mdb "."
679 opens RTNETLINK, listens on it and dumps state changes in the format
680 described in previous sections.
683 If a file name is given, it does not listen on RTNETLINK,
684 but opens the file containing RTNETLINK messages saved in binary format
688 This command uses facilities added in Linux 3.0.
690 Although the forwarding table is maintained on a per-bridge device basis
691 the bridge device is not part of the syntax. This is a limitation of the
692 underlying netlink neighbour message protocol. When displaying the
693 forwarding table, entries for all bridges are displayed.
694 Add/delete/modify commands determine the underlying bridge device
695 based on the bridge to which the corresponding ethernet device is attached.
701 .RB "Please direct bugreports and patches to: " <netdev@vger.kernel.org>
704 Original Manpage by Stephen Hemminger