]>
Commit | Line | Data |
---|---|---|
d04bc300 SH |
1 | .TH BRIDGE 8 "1 August 2012" "iproute2" "Linux" |
2 | .SH NAME | |
3 | bridge \- show / manipulate bridge addresses and devices | |
4 | .SH SYNOPSIS | |
5 | ||
6 | .ad l | |
7 | .in +8 | |
8 | .ti -8 | |
9 | .B bridge | |
10 | .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | " | |
11 | .BR help " }" | |
12 | .sp | |
13 | ||
14 | .ti -8 | |
15 | .IR OBJECT " := { " | |
54e9c3a3 | 16 | .BR link " | " fdb " | " mdb " | " vlan " | " monitor " }" |
d04bc300 SH |
17 | .sp |
18 | ||
19 | .ti -8 | |
20 | .IR OPTIONS " := { " | |
21 | \fB\-V\fR[\fIersion\fR] | | |
527910c8 | 22 | \fB\-s\fR[\fItatistics\fR] | |
db726379 RP |
23 | \fB\-n\fR[\fIetns\fR] name | |
24 | \fB\-b\fR[\fIatch\fR] filename | | |
3a1ca9a5 | 25 | \fB\-c\fR[\folor\fR] | |
01842eb5 | 26 | \fB\-p\fR[\fIretty\fR] | |
05758f5c PS |
27 | \fB\-j\fR[\fIson\fR] | |
28 | \fB\-o\fR[\fIneline\fr] } | |
aa2f1335 VY |
29 | |
30 | .ti -8 | |
31 | .BR "bridge link set" | |
fc31817d | 32 | .B dev |
aa2f1335 VY |
33 | .IR DEV |
34 | .IR " [ " | |
fc31817d | 35 | .B cost |
aa2f1335 | 36 | .IR COST " ] [ " |
fc31817d PS |
37 | .B priority |
38 | .IR PRIO " ] [ " | |
39 | .B state | |
d13d52d0 | 40 | .IR STATE " ] [ " |
aa2f1335 VY |
41 | .BR guard " { " on " | " off " } ] [ " |
42 | .BR hairpin " { " on " | " off " } ] [ " | |
43 | .BR fastleave " { " on " | " off " } ] [ " | |
44 | .BR root_block " { " on " | " off " } ] [ " | |
f0f4ab60 | 45 | .BR learning " { " on " | " off " } ] [ " |
674bb438 | 46 | .BR learning_sync " { " on " | " off " } ] [ " |
f0f4ab60 | 47 | .BR flood " { " on " | " off " } ] [ " |
22a98f51 | 48 | .BR hwmode " { " vepa " | " veb " } ] [ " |
9208b4e7 | 49 | .BR mcast_flood " { " on " | " off " } ] [ " |
b5a754b1 | 50 | .BR mcast_to_unicast " { " on " | " off " } ] [ " |
8cfde5c9 RP |
51 | .BR neigh_suppress " { " on " | " off " } ] [ " |
52 | .BR vlan_tunnel " { " on " | " off " } ] [ " | |
05001bcf | 53 | .BR isolated " { " on " | " off " } ] [ " |
d13d52d0 NA |
54 | .B backup_port |
55 | .IR DEVICE " ] [" | |
56 | .BR nobackup_port " ] [ " | |
9208b4e7 | 57 | .BR self " ] [ " master " ]" |
aa2f1335 VY |
58 | |
59 | .ti -8 | |
60 | .BR "bridge link" " [ " show " ] [ " | |
fc31817d | 61 | .B dev |
aa2f1335 | 62 | .IR DEV " ]" |
d04bc300 SH |
63 | |
64 | .ti -8 | |
6e2e2cf0 | 65 | .BR "bridge fdb" " { " add " | " append " | " del " | " replace " } " |
d04bc300 | 66 | .I LLADDR |
fc31817d | 67 | .B dev |
d04bc300 | 68 | .IR DEV " { " |
c6d0cfb5 | 69 | .BR local " | " static " | " dynamic " } [ " |
c3ded6e4 | 70 | .BR self " ] [ " master " ] [ " router " ] [ " use " ] [ " extern_learn " ] [ " sticky " ] [ " |
fc31817d | 71 | .B dst |
7578ae88 | 72 | .IR IPADDR " ] [ " |
c5b176e5 RP |
73 | .B src_vni |
74 | .IR SRC_VNI " ] [" | |
7578ae88 TR |
75 | .B vni |
76 | .IR VNI " ] [" | |
77 | .B port | |
78 | .IR PORT " ] [" | |
79 | .B via | |
80 | .IR DEVICE " ]" | |
d04bc300 SH |
81 | |
82 | .ti -8 | |
83 | .BR "bridge fdb" " [ " show " ] [ " | |
fc31817d | 84 | .B dev |
7f10090b NA |
85 | .IR DEV " ] [ " |
86 | .B br | |
87 | .IR BRDEV " ] [ " | |
88 | .B brport | |
89 | .IR DEV " ] [ " | |
90 | .B vlan | |
91 | .IR VID " ] [ " | |
92 | .B state | |
93 | .IR STATE " ]" | |
d04bc300 | 94 | |
54e9c3a3 PP |
95 | .ti -8 |
96 | .BR "bridge mdb" " { " add " | " del " } " | |
fc31817d | 97 | .B dev |
54e9c3a3 PP |
98 | .IR DEV |
99 | .B port | |
100 | .IR PORT | |
101 | .B grp | |
102 | .IR GROUP " [ " | |
6aac8617 NA |
103 | .BR permanent " | " temp " ] [ " |
104 | .B vid | |
105 | .IR VID " ] " | |
54e9c3a3 PP |
106 | |
107 | .ti -8 | |
108 | .BR "bridge mdb show " [ " | |
fc31817d | 109 | .B dev |
54e9c3a3 PP |
110 | .IR DEV " ]" |
111 | ||
ab938710 VY |
112 | .ti -8 |
113 | .BR "bridge vlan" " { " add " | " del " } " | |
fc31817d | 114 | .B dev |
ab938710 | 115 | .IR DEV |
fc31817d | 116 | .B vid |
ab938710 | 117 | .IR VID " [ " |
8652eeb3 RP |
118 | .BR tunnel_info |
119 | .IR TUNNEL_ID " ] [ " | |
fc31817d PS |
120 | .BR pvid " ] [ " untagged " ] [ " |
121 | .BR self " ] [ " master " ] " | |
ab938710 VY |
122 | |
123 | .ti -8 | |
8652eeb3 | 124 | .BR "bridge vlan" " [ " show " | " tunnelshow " ] [ " |
fc31817d | 125 | .B dev |
ab938710 VY |
126 | .IR DEV " ]" |
127 | ||
d04bc300 | 128 | .ti -8 |
54e9c3a3 | 129 | .BR "bridge monitor" " [ " all " | " neigh " | " link " | " mdb " ]" |
d04bc300 SH |
130 | |
131 | .SH OPTIONS | |
132 | ||
133 | .TP | |
134 | .BR "\-V" , " -Version" | |
135 | print the version of the | |
136 | .B bridge | |
137 | utility and exit. | |
138 | ||
139 | .TP | |
140 | .BR "\-s" , " \-stats", " \-statistics" | |
a89d5329 | 141 | output more information. If this option |
49572501 | 142 | is given multiple times, the amount of information increases. |
d04bc300 SH |
143 | As a rule, the information is statistics or some time values. |
144 | ||
ba037267 NA |
145 | .TP |
146 | .BR "\-d" , " \-details" | |
147 | print detailed information about MDB router ports. | |
148 | ||
527910c8 VK |
149 | .TP |
150 | .BR "\-n" , " \-net" , " \-netns " <NETNS> | |
151 | switches | |
152 | .B bridge | |
153 | to the specified network namespace | |
154 | .IR NETNS . | |
155 | Actually it just simplifies executing of: | |
156 | ||
157 | .B ip netns exec | |
158 | .IR NETNS | |
159 | .B bridge | |
160 | .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | " | |
161 | .BR help " }" | |
162 | ||
163 | to | |
164 | ||
165 | .B bridge | |
166 | .RI "-n[etns] " NETNS " [ " OPTIONS " ] " OBJECT " { " COMMAND " | " | |
167 | .BR help " }" | |
168 | ||
9de8c6d9 WK |
169 | .TP |
170 | .BR "\-b", " \-batch " <FILENAME> | |
171 | Read commands from provided file or standard input and invoke them. | |
172 | First failure will cause termination of bridge command. | |
173 | ||
174 | .TP | |
175 | .BR "\-force" | |
176 | Don't terminate bridge command on errors in batch mode. | |
177 | If there were any errors during execution of the commands, the application | |
178 | return code will be non zero. | |
d04bc300 | 179 | |
db726379 | 180 | .TP |
ff1ab8ed PS |
181 | .BR \-c [ color ][ = { always | auto | never } |
182 | Configure color output. If parameter is omitted or | |
183 | .BR always , | |
184 | color output is enabled regardless of stdout state. If parameter is | |
185 | .BR auto , | |
186 | stdout is checked to be a terminal before enabling color output. If parameter is | |
187 | .BR never , | |
188 | color output is disabled. If specified multiple times, the last one takes | |
189 | precedence. This flag is ignored if | |
190 | .B \-json | |
191 | is also given. | |
db726379 | 192 | |
01842eb5 | 193 | .TP |
3a1ca9a5 SH |
194 | .BR "\-j", " \-json" |
195 | Output results in JavaScript Object Notation (JSON). | |
196 | ||
197 | .TP | |
198 | .BR "\-p", " \-pretty" | |
01842eb5 SH |
199 | When combined with -j generate a pretty JSON output. |
200 | ||
05758f5c PS |
201 | .TP |
202 | .BR "\-o", " \-oneline" | |
203 | output each record on a single line, replacing line feeds | |
204 | with the | |
205 | .B '\e' | |
206 | character. This is convenient when you want to count records | |
207 | with | |
208 | .BR wc (1) | |
209 | or to | |
210 | .BR grep (1) | |
211 | the output. | |
212 | ||
01842eb5 | 213 | |
d04bc300 SH |
214 | .SH BRIDGE - COMMAND SYNTAX |
215 | ||
216 | .SS | |
217 | .I OBJECT | |
218 | ||
aa2f1335 VY |
219 | .TP |
220 | .B link | |
221 | - Bridge port. | |
222 | ||
d04bc300 | 223 | .TP |
5699275b | 224 | .B fdb |
d04bc300 SH |
225 | - Forwarding Database entry. |
226 | ||
54e9c3a3 PP |
227 | .TP |
228 | .B mdb | |
229 | - Multicast group database entry. | |
230 | ||
ab938710 VY |
231 | .TP |
232 | .B vlan | |
233 | - VLAN filter list. | |
234 | ||
d04bc300 SH |
235 | .SS |
236 | .I COMMAND | |
237 | ||
238 | Specifies the action to perform on the object. | |
239 | The set of possible actions depends on the object type. | |
240 | As a rule, it is possible to | |
241 | .BR "add" , " delete" | |
242 | and | |
243 | .B show | |
244 | (or | |
245 | .B list | |
246 | ) objects, but some objects do not allow all of these operations | |
a89d5329 | 247 | or have some additional commands. The |
d04bc300 | 248 | .B help |
a89d5329 | 249 | command is available for all objects. It prints |
d04bc300 SH |
250 | out a list of available commands and argument syntax conventions. |
251 | .sp | |
252 | If no command is given, some default command is assumed. | |
253 | Usually it is | |
254 | .B list | |
255 | or, if the objects of this class cannot be listed, | |
256 | .BR "help" . | |
257 | ||
aa2f1335 VY |
258 | .SH bridge link - bridge port |
259 | ||
260 | .B link | |
261 | objects correspond to the port devices of the bridge. | |
262 | ||
263 | .P | |
264 | The corresponding commands set and display port status and bridge specific | |
265 | attributes. | |
266 | ||
267 | .SS bridge link set - set bridge specific attributes on a port | |
268 | ||
269 | .TP | |
270 | .BI dev " NAME " | |
271 | interface name of the bridge port | |
272 | ||
273 | .TP | |
274 | .BI cost " COST " | |
275 | the STP path cost of the specified port. | |
276 | ||
277 | .TP | |
278 | .BI priority " PRIO " | |
a89d5329 PŠ |
279 | the STP port priority. The priority value is an unsigned 8-bit quantity |
280 | (number between 0 and 255). This metric is used in the designated port an | |
aa2f1335 VY |
281 | droot port selectio algorithms. |
282 | ||
283 | .TP | |
284 | .BI state " STATE " | |
a89d5329 PŠ |
285 | the operation state of the port. This is primarily used by user space STP/RSTP |
286 | implementation. One may enter a lowercased port state name, or one of the | |
287 | numbers below. Negative inputs are ignored, and unrecognized names return an | |
6b8c871d | 288 | error. |
aa2f1335 VY |
289 | |
290 | .B 0 | |
a89d5329 | 291 | - port is DISABLED. Make this port completely inactive. |
aa2f1335 VY |
292 | .sp |
293 | ||
294 | .B 1 | |
7fab22ab | 295 | - STP LISTENING state. Only valid if STP is enabled on the bridge. In this |
3aa8f8cb | 296 | state the port listens for STP BPDUs and drops all other traffic frames. |
aa2f1335 VY |
297 | .sp |
298 | ||
299 | .B 2 | |
a89d5329 | 300 | - STP LEARNING state. Only valid if STP is enabled on the bridge. In this |
aa2f1335 | 301 | state the port will accept traffic only for the purpose of updating MAC |
ac0817ef | 302 | address tables. |
aa2f1335 VY |
303 | .sp |
304 | ||
305 | .B 3 | |
a89d5329 | 306 | - STP FORWARDING state. Port is fully active. |
aa2f1335 VY |
307 | .sp |
308 | ||
309 | .B 4 | |
a89d5329 PŠ |
310 | - STP BLOCKING state. Only valid if STP is enabled on the bridge. This state |
311 | is used during the STP election process. In this state, port will only process | |
aa2f1335 VY |
312 | STP BPDUs. |
313 | .sp | |
314 | ||
315 | .TP | |
316 | .BR "guard on " or " guard off " | |
400b5404 | 317 | Controls whether STP BPDUs will be processed by the bridge port. By default, |
a89d5329 | 318 | the flag is turned off allowed BPDU processing. Turning this flag on will |
aa2f1335 VY |
319 | cause the port to stop processing STP BPDUs. |
320 | ||
321 | .TP | |
322 | .BR "hairpin on " or " hairpin off " | |
323 | Controls whether traffic may be send back out of the port on which it was | |
a89d5329 | 324 | received. By default, this flag is turned off and the bridge will not forward |
aa2f1335 VY |
325 | traffic back out of the receiving port. |
326 | ||
327 | .TP | |
328 | .BR "fastleave on " or " fastleave off " | |
329 | This flag allows the bridge to immediately stop multicast traffic on a port | |
a89d5329 PŠ |
330 | that receives IGMP Leave message. It is only used with IGMP snooping is |
331 | enabled on the bridge. By default the flag is off. | |
aa2f1335 VY |
332 | |
333 | .TP | |
334 | .BR "root_block on " or " root_block off " | |
a89d5329 PŠ |
335 | Controls whether a given port is allowed to become root port or not. Only used |
336 | when STP is enabled on the bridge. By default the flag is off. | |
aa2f1335 | 337 | |
f0f4ab60 VY |
338 | .TP |
339 | .BR "learning on " or " learning off " | |
340 | Controls whether a given port will learn MAC addresses from received traffic or | |
a89d5329 PŠ |
341 | not. If learning if off, the bridge will end up flooding any traffic for which |
342 | it has no FDB entry. By default this flag is on. | |
f0f4ab60 | 343 | |
674bb438 SF |
344 | .TP |
345 | .BR "learning_sync on " or " learning_sync off " | |
346 | Controls whether a given port will sync MAC addresses learned on device port to | |
347 | bridge FDB. | |
348 | ||
f0f4ab60 | 349 | .TP |
02723cf2 | 350 | .BR "flood on " or " flood off " |
a89d5329 | 351 | Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on. |
f0f4ab60 | 352 | |
aa2f1335 VY |
353 | .TP |
354 | .BI hwmode | |
355 | Some network interface cards support HW bridge functionality and they may be | |
a89d5329 | 356 | configured in different modes. Currently support modes are: |
aa2f1335 VY |
357 | |
358 | .B vepa | |
359 | - Data sent between HW ports is sent on the wire to the external | |
360 | switch. | |
361 | ||
362 | .B veb | |
363 | - bridging happens in hardware. | |
364 | ||
9208b4e7 NA |
365 | .TP |
366 | .BR "mcast_flood on " or " mcast_flood off " | |
f76ad635 SH |
367 | Controls whether a given port will flood multicast traffic for which |
368 | there is no MDB entry. By default this flag is on. | |
9208b4e7 | 369 | |
b5a754b1 TJ |
370 | .TP |
371 | .BR "mcast_to_unicast on " or " mcast_to_unicast off " | |
f76ad635 SH |
372 | Controls whether a given port will replicate packets using unicast |
373 | instead of multicast. By default this flag is off. | |
b5a754b1 | 374 | |
41973a47 RP |
375 | .TP |
376 | .BR "neigh_suppress on " or " neigh_suppress off " | |
f76ad635 SH |
377 | Controls whether neigh discovery (arp and nd) proxy and suppression is |
378 | enabled on the port. By default this flag is off. | |
41973a47 | 379 | |
8cfde5c9 RP |
380 | .TP |
381 | .BR "vlan_tunnel on " or " vlan_tunnel off " | |
f76ad635 SH |
382 | Controls whether vlan to tunnel mapping is enabled on the port. By |
383 | default this flag is off. | |
8cfde5c9 | 384 | |
05001bcf NA |
385 | .TP |
386 | .BR "isolated on " or " isolated off " | |
f76ad635 SH |
387 | Controls whether a given port will be isolated, which means it will be |
388 | able to communicate with non-isolated ports only. By default this | |
389 | flag is off. | |
05001bcf | 390 | |
d13d52d0 NA |
391 | .TP |
392 | .BI backup_port " DEVICE" | |
f76ad635 SH |
393 | If the port loses carrier all traffic will be redirected to the |
394 | configured backup port | |
d13d52d0 NA |
395 | |
396 | .TP | |
397 | .BR nobackup_port | |
398 | Removes the currently configured backup port | |
399 | ||
22a98f51 RP |
400 | .TP |
401 | .BI self | |
402 | link setting is configured on specified physical device | |
403 | ||
404 | .TP | |
405 | .BI master | |
406 | link setting is configured on the software bridge (default) | |
407 | ||
25bc3d3d SA |
408 | .TP |
409 | .BR "\-t" , " \-timestamp" | |
410 | display current time when using monitor option. | |
22a98f51 | 411 | |
aa2f1335 VY |
412 | .SS bridge link show - list bridge port configuration. |
413 | ||
414 | This command displays the current bridge port configuration and flags. | |
415 | ||
d04bc300 SH |
416 | .SH bridge fdb - forwarding database management |
417 | ||
418 | .B fdb | |
fc31817d | 419 | objects contain known Ethernet addresses on a link. |
d04bc300 SH |
420 | |
421 | .P | |
422 | The corresponding commands display fdb entries, add new entries, | |
7578ae88 | 423 | append entries, |
d04bc300 SH |
424 | and delete old ones. |
425 | ||
d611682a | 426 | .SS bridge fdb add - add a new fdb entry |
d04bc300 | 427 | |
d611682a | 428 | This command creates a new fdb entry. |
d04bc300 SH |
429 | |
430 | .TP | |
7578ae88 | 431 | .BI "LLADDR" |
d04bc300 SH |
432 | the Ethernet MAC address. |
433 | ||
434 | .TP | |
7578ae88 | 435 | .BI dev " DEV" |
d04bc300 SH |
436 | the interface to which this address is associated. |
437 | ||
c6d0cfb5 RP |
438 | .B local |
439 | - is a local permanent fdb entry | |
440 | .sp | |
441 | ||
442 | .B static | |
443 | - is a static (no arp) fdb entry | |
444 | .sp | |
445 | ||
446 | .B dynamic | |
447 | - is a dynamic reachable age-able fdb entry | |
448 | .sp | |
449 | ||
d611682a | 450 | .B self |
cd8df30b RP |
451 | - the address is associated with the port drivers fdb. Usually hardware. |
452 | .sp | |
453 | ||
454 | .B master | |
455 | - the address is associated with master devices fdb. Usually software (default). | |
d611682a JF |
456 | .sp |
457 | ||
7578ae88 TR |
458 | .B router |
459 | - the destination address is associated with a router. | |
460 | Valid if the referenced device is a VXLAN type device and has | |
461 | route shortcircuit enabled. | |
462 | .sp | |
463 | ||
cd8df30b RP |
464 | .B use |
465 | - the address is in use. User space can use this option to | |
466 | indicate to the kernel that the fdb entry is in use. | |
467 | .sp | |
468 | ||
b4f84bf8 RP |
469 | .B extern_learn |
470 | - this entry was learned externally. This option can be used to | |
471 | indicate to the kernel that an entry was hardware or user-space | |
472 | controller learnt dynamic entry. Kernel will not age such an entry. | |
473 | .sp | |
474 | ||
c3ded6e4 NA |
475 | .B sticky |
476 | - this entry will not change its port due to learning. | |
477 | .sp | |
478 | ||
d04bc300 | 479 | .in -8 |
7578ae88 TR |
480 | The next command line parameters apply only |
481 | when the specified device | |
482 | .I DEV | |
483 | is of type VXLAN. | |
484 | .TP | |
485 | .BI dst " IPADDR" | |
486 | the IP address of the destination | |
487 | VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides. | |
488 | ||
c5b176e5 RP |
489 | .TP |
490 | .BI src_vni " SRC VNI" | |
491 | the src VNI Network Identifier (or VXLAN Segment ID) | |
492 | this entry belongs to. Used only when the vxlan device is in | |
493 | external or collect metadata mode. If omitted the value specified at | |
494 | vxlan device creation will be used. | |
495 | ||
7578ae88 TR |
496 | .TP |
497 | .BI vni " VNI" | |
498 | the VXLAN VNI Network Identifier (or VXLAN Segment ID) | |
499 | to use to connect to the remote VXLAN tunnel endpoint. | |
500 | If omitted the value specified at vxlan device creation | |
501 | will be used. | |
502 | ||
503 | .TP | |
504 | .BI port " PORT" | |
505 | the UDP destination PORT number to use to connect to the | |
506 | remote VXLAN tunnel endpoint. | |
507 | If omitted the default value is used. | |
508 | ||
509 | .TP | |
510 | .BI via " DEVICE" | |
511 | device name of the outgoing interface for the | |
512 | VXLAN device driver to reach the | |
5699275b | 513 | remote VXLAN tunnel endpoint. |
7578ae88 TR |
514 | |
515 | .SS bridge fdb append - append a forwarding database entry | |
516 | This command adds a new fdb entry with an already known | |
517 | .IR LLADDR . | |
518 | Valid only for multicast link layer addresses. | |
519 | The command adds support for broadcast and multicast | |
520 | Ethernet MAC addresses. | |
521 | The Ethernet MAC address is added multiple times into | |
522 | the forwarding database and the vxlan device driver | |
523 | sends a copy of the data packet to each entry found. | |
524 | ||
525 | .PP | |
526 | The arguments are the same as with | |
fc31817d | 527 | .BR "bridge fdb add" . |
d04bc300 SH |
528 | |
529 | .SS bridge fdb delete - delete a forwarding database entry | |
530 | This command removes an existing fdb entry. | |
531 | ||
532 | .PP | |
533 | The arguments are the same as with | |
fc31817d | 534 | .BR "bridge fdb add" . |
d04bc300 | 535 | |
6e2e2cf0 PS |
536 | .SS bridge fdb replace - replace a forwarding database entry |
537 | If no matching entry is found, a new one will be created instead. | |
538 | ||
539 | .PP | |
540 | The arguments are the same as with | |
fc31817d | 541 | .BR "bridge fdb add" . |
6e2e2cf0 | 542 | |
d04bc300 SH |
543 | .SS bridge fdb show - list forwarding entries. |
544 | ||
49572501 | 545 | This command displays the current forwarding table. |
d04bc300 SH |
546 | |
547 | .PP | |
548 | With the | |
549 | .B -statistics | |
a89d5329 | 550 | option, the command becomes verbose. It prints out the last updated |
d04bc300 SH |
551 | and last used time for each entry. |
552 | ||
54e9c3a3 PP |
553 | .SH bridge mdb - multicast group database management |
554 | ||
555 | .B mdb | |
556 | objects contain known IP multicast group addresses on a link. | |
557 | ||
558 | .P | |
559 | The corresponding commands display mdb entries, add new entries, | |
560 | and delete old ones. | |
561 | ||
562 | .SS bridge mdb add - add a new multicast group database entry | |
563 | ||
564 | This command creates a new mdb entry. | |
565 | ||
566 | .TP | |
567 | .BI dev " DEV" | |
568 | the interface where this group address is associated. | |
569 | ||
570 | .TP | |
571 | .BI port " PORT" | |
572 | the port whose link is known to have members of this multicast group. | |
573 | ||
574 | .TP | |
575 | .BI grp " GROUP" | |
576 | the IP multicast group address whose members reside on the link connected to | |
577 | the port. | |
578 | ||
579 | .B permanent | |
580 | - the mdb entry is permanent | |
581 | .sp | |
582 | ||
583 | .B temp | |
584 | - the mdb entry is temporary (default) | |
585 | .sp | |
586 | ||
6aac8617 NA |
587 | .TP |
588 | .BI vid " VID" | |
589 | the VLAN ID which is known to have members of this multicast group. | |
590 | ||
54e9c3a3 PP |
591 | .in -8 |
592 | .SS bridge mdb delete - delete a multicast group database entry | |
593 | This command removes an existing mdb entry. | |
594 | ||
595 | .PP | |
596 | The arguments are the same as with | |
597 | .BR "bridge mdb add" . | |
598 | ||
599 | .SS bridge mdb show - list multicast group database entries | |
600 | ||
601 | This command displays the current multicast group membership table. The table | |
602 | is populated by IGMP and MLD snooping in the bridge driver automatically. It | |
603 | can be altered by | |
604 | .B bridge mdb add | |
605 | and | |
606 | .B bridge mdb del | |
607 | commands manually too. | |
608 | ||
609 | .TP | |
610 | .BI dev " DEV" | |
611 | the interface only whose entries should be listed. Default is to list all | |
612 | bridge interfaces. | |
613 | ||
614 | .PP | |
615 | With the | |
616 | .B -details | |
a89d5329 | 617 | option, the command becomes verbose. It prints out the ports known to have |
54e9c3a3 PP |
618 | a connected router. |
619 | ||
05d4f64d NA |
620 | .PP |
621 | With the | |
622 | .B -statistics | |
ba037267 | 623 | option, the command displays timer values for mdb and router port entries. |
05d4f64d | 624 | |
ab938710 VY |
625 | .SH bridge vlan - VLAN filter list |
626 | ||
627 | .B vlan | |
628 | objects contain known VLAN IDs for a link. | |
629 | ||
630 | .P | |
631 | The corresponding commands display vlan filter entries, add new entries, | |
632 | and delete old ones. | |
633 | ||
634 | .SS bridge vlan add - add a new vlan filter entry | |
635 | ||
636 | This command creates a new vlan filter entry. | |
637 | ||
638 | .TP | |
639 | .BI dev " NAME" | |
640 | the interface with which this vlan is associated. | |
641 | ||
642 | .TP | |
643 | .BI vid " VID" | |
644 | the VLAN ID that identifies the vlan. | |
645 | ||
8652eeb3 RP |
646 | .TP |
647 | .BI tunnel_info " TUNNEL_ID" | |
f76ad635 SH |
648 | the TUNNEL ID that maps to this vlan. The tunnel id is set in |
649 | dst_metadata for every packet that belongs to this vlan (applicable to | |
650 | bridge ports with vlan_tunnel flag set). | |
8652eeb3 | 651 | |
ab938710 VY |
652 | .TP |
653 | .BI pvid | |
654 | the vlan specified is to be considered a PVID at ingress. | |
655 | Any untagged frames will be assigned to this VLAN. | |
656 | ||
657 | .TP | |
658 | .BI untagged | |
659 | the vlan specified is to be treated as untagged on egress. | |
660 | ||
661 | .TP | |
662 | .BI self | |
a89d5329 | 663 | the vlan is configured on the specified physical device. Required if the |
ab938710 VY |
664 | device is the bridge device. |
665 | ||
666 | .TP | |
667 | .BI master | |
6274b0b7 | 668 | the vlan is configured on the software bridge (default). |
ab938710 | 669 | |
296cee6f VD |
670 | .SS bridge vlan delete - delete a vlan filter entry |
671 | This command removes an existing vlan filter entry. | |
ab938710 VY |
672 | |
673 | .PP | |
674 | The arguments are the same as with | |
675 | .BR "bridge vlan add". | |
676 | The | |
677 | .BR "pvid " and " untagged" | |
678 | flags are ignored. | |
679 | ||
680 | .SS bridge vlan show - list vlan configuration. | |
681 | ||
682 | This command displays the current VLAN filter table. | |
683 | ||
7abf5de6 NA |
684 | .PP |
685 | With the | |
686 | .B -statistics | |
687 | option, the command displays per-vlan traffic statistics. | |
688 | ||
8652eeb3 RP |
689 | .SS bridge vlan tunnelshow - list vlan tunnel mapping. |
690 | ||
691 | This command displays the current vlan tunnel info mapping. | |
692 | ||
d04bc300 SH |
693 | .SH bridge monitor - state monitoring |
694 | ||
695 | The | |
696 | .B bridge | |
fc31817d | 697 | utility can monitor the state of devices and addresses |
a89d5329 | 698 | continuously. This option has a slightly different format. |
d04bc300 SH |
699 | Namely, the |
700 | .B monitor | |
701 | command is the first in the command line and then the object list follows: | |
702 | ||
703 | .BR "bridge monitor" " [ " all " |" | |
49572501 | 704 | .IR OBJECT-LIST " ]" |
d04bc300 SH |
705 | |
706 | .I OBJECT-LIST | |
707 | is the list of object types that we want to monitor. | |
708 | It may contain | |
fc31817d | 709 | .BR link ", " fdb ", and " mdb "." |
d04bc300 SH |
710 | If no |
711 | .B file | |
712 | argument is given, | |
713 | .B bridge | |
714 | opens RTNETLINK, listens on it and dumps state changes in the format | |
715 | described in previous sections. | |
716 | ||
717 | .P | |
718 | If a file name is given, it does not listen on RTNETLINK, | |
719 | but opens the file containing RTNETLINK messages saved in binary format | |
efb16971 | 720 | and dumps them. |
d04bc300 SH |
721 | |
722 | .SH NOTES | |
723 | This command uses facilities added in Linux 3.0. | |
724 | ||
725 | Although the forwarding table is maintained on a per-bridge device basis | |
726 | the bridge device is not part of the syntax. This is a limitation of the | |
727 | underlying netlink neighbour message protocol. When displaying the | |
728 | forwarding table, entries for all bridges are displayed. | |
729 | Add/delete/modify commands determine the underlying bridge device | |
6274b0b7 | 730 | based on the bridge to which the corresponding ethernet device is attached. |
d04bc300 SH |
731 | |
732 | ||
733 | .SH SEE ALSO | |
734 | .BR ip (8) | |
49572501 | 735 | .SH BUGS |
d04bc300 SH |
736 | .RB "Please direct bugreports and patches to: " <netdev@vger.kernel.org> |
737 | ||
738 | .SH AUTHOR | |
739 | Original Manpage by Stephen Hemminger |