]>
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 VK |
22 | \fB\-s\fR[\fItatistics\fR] | |
23 | \fB\-n\fR[\fIetns\fR] name } | |
9de8c6d9 | 24 | \fB\-b\fR[\fIatch\fR] filename } |
aa2f1335 VY |
25 | |
26 | .ti -8 | |
27 | .BR "bridge link set" | |
28 | .B dev | |
29 | .IR DEV | |
30 | .IR " [ " | |
31 | .B cost | |
32 | .IR COST " ] [ " | |
33 | .B priority | |
34 | .IR PRIO " ] [ " | |
35 | .B state | |
36 | .IR STATE "] [" | |
37 | .BR guard " { " on " | " off " } ] [ " | |
38 | .BR hairpin " { " on " | " off " } ] [ " | |
39 | .BR fastleave " { " on " | " off " } ] [ " | |
40 | .BR root_block " { " on " | " off " } ] [ " | |
f0f4ab60 | 41 | .BR learning " { " on " | " off " } ] [ " |
674bb438 | 42 | .BR learning_sync " { " on " | " off " } ] [ " |
f0f4ab60 | 43 | .BR flood " { " on " | " off " } ] [ " |
22a98f51 RP |
44 | .BR hwmode " { " vepa " | " veb " } ] [ " |
45 | .BR self " ] [ " master " ] " | |
aa2f1335 VY |
46 | |
47 | .ti -8 | |
48 | .BR "bridge link" " [ " show " ] [ " | |
49 | .B dev | |
50 | .IR DEV " ]" | |
d04bc300 SH |
51 | |
52 | .ti -8 | |
7578ae88 | 53 | .BR "bridge fdb" " { " add " | " append " | " del " } " |
d04bc300 SH |
54 | .I LLADDR |
55 | .B dev | |
56 | .IR DEV " { " | |
cd8df30b RP |
57 | .BR local " | " temp " } [ " |
58 | .BR self " ] [ " master " ] [ " router " ] [ " use " ] [ " | |
7578ae88 TR |
59 | .B dst |
60 | .IR IPADDR " ] [ " | |
61 | .B vni | |
62 | .IR VNI " ] [" | |
63 | .B port | |
64 | .IR PORT " ] [" | |
65 | .B via | |
66 | .IR DEVICE " ]" | |
d04bc300 SH |
67 | |
68 | .ti -8 | |
69 | .BR "bridge fdb" " [ " show " ] [ " | |
70 | .B dev | |
71 | .IR DEV " ]" | |
72 | ||
54e9c3a3 PP |
73 | .ti -8 |
74 | .BR "bridge mdb" " { " add " | " del " } " | |
75 | .B dev | |
76 | .IR DEV | |
77 | .B port | |
78 | .IR PORT | |
79 | .B grp | |
80 | .IR GROUP " [ " | |
6aac8617 NA |
81 | .BR permanent " | " temp " ] [ " |
82 | .B vid | |
83 | .IR VID " ] " | |
54e9c3a3 PP |
84 | |
85 | .ti -8 | |
86 | .BR "bridge mdb show " [ " | |
87 | .B dev | |
88 | .IR DEV " ]" | |
89 | ||
ab938710 VY |
90 | .ti -8 |
91 | .BR "bridge vlan" " { " add " | " del " } " | |
92 | .B dev | |
93 | .IR DEV | |
94 | .B vid | |
95 | .IR VID " [ " | |
96 | .BR pvid " ] [ " untagged " ] [ " | |
97 | .BR self " ] [ " master " ] " | |
98 | ||
99 | .ti -8 | |
100 | .BR "bridge vlan" " [ " show " ] [ " | |
101 | .B dev | |
102 | .IR DEV " ]" | |
103 | ||
d04bc300 | 104 | .ti -8 |
54e9c3a3 | 105 | .BR "bridge monitor" " [ " all " | " neigh " | " link " | " mdb " ]" |
d04bc300 SH |
106 | |
107 | .SH OPTIONS | |
108 | ||
109 | .TP | |
110 | .BR "\-V" , " -Version" | |
111 | print the version of the | |
112 | .B bridge | |
113 | utility and exit. | |
114 | ||
115 | .TP | |
116 | .BR "\-s" , " \-stats", " \-statistics" | |
a89d5329 | 117 | output more information. If this option |
49572501 | 118 | is given multiple times, the amount of information increases. |
d04bc300 SH |
119 | As a rule, the information is statistics or some time values. |
120 | ||
527910c8 VK |
121 | .TP |
122 | .BR "\-n" , " \-net" , " \-netns " <NETNS> | |
123 | switches | |
124 | .B bridge | |
125 | to the specified network namespace | |
126 | .IR NETNS . | |
127 | Actually it just simplifies executing of: | |
128 | ||
129 | .B ip netns exec | |
130 | .IR NETNS | |
131 | .B bridge | |
132 | .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | " | |
133 | .BR help " }" | |
134 | ||
135 | to | |
136 | ||
137 | .B bridge | |
138 | .RI "-n[etns] " NETNS " [ " OPTIONS " ] " OBJECT " { " COMMAND " | " | |
139 | .BR help " }" | |
140 | ||
9de8c6d9 WK |
141 | .TP |
142 | .BR "\-b", " \-batch " <FILENAME> | |
143 | Read commands from provided file or standard input and invoke them. | |
144 | First failure will cause termination of bridge command. | |
145 | ||
146 | .TP | |
147 | .BR "\-force" | |
148 | Don't terminate bridge command on errors in batch mode. | |
149 | If there were any errors during execution of the commands, the application | |
150 | return code will be non zero. | |
d04bc300 SH |
151 | |
152 | .SH BRIDGE - COMMAND SYNTAX | |
153 | ||
154 | .SS | |
155 | .I OBJECT | |
156 | ||
aa2f1335 VY |
157 | .TP |
158 | .B link | |
159 | - Bridge port. | |
160 | ||
d04bc300 SH |
161 | .TP |
162 | .B fdb | |
163 | - Forwarding Database entry. | |
164 | ||
54e9c3a3 PP |
165 | .TP |
166 | .B mdb | |
167 | - Multicast group database entry. | |
168 | ||
ab938710 VY |
169 | .TP |
170 | .B vlan | |
171 | - VLAN filter list. | |
172 | ||
d04bc300 SH |
173 | .SS |
174 | .I COMMAND | |
175 | ||
176 | Specifies the action to perform on the object. | |
177 | The set of possible actions depends on the object type. | |
178 | As a rule, it is possible to | |
179 | .BR "add" , " delete" | |
180 | and | |
181 | .B show | |
182 | (or | |
183 | .B list | |
184 | ) objects, but some objects do not allow all of these operations | |
a89d5329 | 185 | or have some additional commands. The |
d04bc300 | 186 | .B help |
a89d5329 | 187 | command is available for all objects. It prints |
d04bc300 SH |
188 | out a list of available commands and argument syntax conventions. |
189 | .sp | |
190 | If no command is given, some default command is assumed. | |
191 | Usually it is | |
192 | .B list | |
193 | or, if the objects of this class cannot be listed, | |
194 | .BR "help" . | |
195 | ||
aa2f1335 VY |
196 | .SH bridge link - bridge port |
197 | ||
198 | .B link | |
199 | objects correspond to the port devices of the bridge. | |
200 | ||
201 | .P | |
202 | The corresponding commands set and display port status and bridge specific | |
203 | attributes. | |
204 | ||
205 | .SS bridge link set - set bridge specific attributes on a port | |
206 | ||
207 | .TP | |
208 | .BI dev " NAME " | |
209 | interface name of the bridge port | |
210 | ||
211 | .TP | |
212 | .BI cost " COST " | |
213 | the STP path cost of the specified port. | |
214 | ||
215 | .TP | |
216 | .BI priority " PRIO " | |
a89d5329 PŠ |
217 | the STP port priority. The priority value is an unsigned 8-bit quantity |
218 | (number between 0 and 255). This metric is used in the designated port an | |
aa2f1335 VY |
219 | droot port selectio algorithms. |
220 | ||
221 | .TP | |
222 | .BI state " STATE " | |
a89d5329 PŠ |
223 | the operation state of the port. This is primarily used by user space STP/RSTP |
224 | implementation. One may enter a lowercased port state name, or one of the | |
225 | numbers below. Negative inputs are ignored, and unrecognized names return an | |
6b8c871d | 226 | error. |
aa2f1335 VY |
227 | |
228 | .B 0 | |
a89d5329 | 229 | - port is DISABLED. Make this port completely inactive. |
aa2f1335 VY |
230 | .sp |
231 | ||
232 | .B 1 | |
a89d5329 | 233 | - STP LISTENING state. Only valid if STP is enabled on the brige. In this |
aa2f1335 VY |
234 | state the port for list for STP BPDUs and drop all other traffic. |
235 | .sp | |
236 | ||
237 | .B 2 | |
a89d5329 | 238 | - STP LEARNING state. Only valid if STP is enabled on the bridge. In this |
aa2f1335 VY |
239 | state the port will accept traffic only for the purpose of updating MAC |
240 | adress tables. | |
241 | .sp | |
242 | ||
243 | .B 3 | |
a89d5329 | 244 | - STP FORWARDING state. Port is fully active. |
aa2f1335 VY |
245 | .sp |
246 | ||
247 | .B 4 | |
a89d5329 PŠ |
248 | - STP BLOCKING state. Only valid if STP is enabled on the bridge. This state |
249 | is used during the STP election process. In this state, port will only process | |
aa2f1335 VY |
250 | STP BPDUs. |
251 | .sp | |
252 | ||
253 | .TP | |
254 | .BR "guard on " or " guard off " | |
a89d5329 PŠ |
255 | Controls whether STP BPUDs will be processed by the bridge port. By default, |
256 | the flag is turned off allowed BPDU processing. Turning this flag on will | |
aa2f1335 VY |
257 | cause the port to stop processing STP BPDUs. |
258 | ||
259 | .TP | |
260 | .BR "hairpin on " or " hairpin off " | |
261 | Controls whether traffic may be send back out of the port on which it was | |
a89d5329 | 262 | received. By default, this flag is turned off and the bridge will not forward |
aa2f1335 VY |
263 | traffic back out of the receiving port. |
264 | ||
265 | .TP | |
266 | .BR "fastleave on " or " fastleave off " | |
267 | This flag allows the bridge to immediately stop multicast traffic on a port | |
a89d5329 PŠ |
268 | that receives IGMP Leave message. It is only used with IGMP snooping is |
269 | enabled on the bridge. By default the flag is off. | |
aa2f1335 VY |
270 | |
271 | .TP | |
272 | .BR "root_block on " or " root_block off " | |
a89d5329 PŠ |
273 | Controls whether a given port is allowed to become root port or not. Only used |
274 | when STP is enabled on the bridge. By default the flag is off. | |
aa2f1335 | 275 | |
f0f4ab60 VY |
276 | .TP |
277 | .BR "learning on " or " learning off " | |
278 | Controls whether a given port will learn MAC addresses from received traffic or | |
a89d5329 PŠ |
279 | not. If learning if off, the bridge will end up flooding any traffic for which |
280 | it has no FDB entry. By default this flag is on. | |
f0f4ab60 | 281 | |
674bb438 SF |
282 | .TP |
283 | .BR "learning_sync on " or " learning_sync off " | |
284 | Controls whether a given port will sync MAC addresses learned on device port to | |
285 | bridge FDB. | |
286 | ||
f0f4ab60 VY |
287 | .TP |
288 | .BR "flooding on " or " flooding off " | |
a89d5329 | 289 | Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on. |
f0f4ab60 | 290 | |
aa2f1335 VY |
291 | .TP |
292 | .BI hwmode | |
293 | Some network interface cards support HW bridge functionality and they may be | |
a89d5329 | 294 | configured in different modes. Currently support modes are: |
aa2f1335 VY |
295 | |
296 | .B vepa | |
297 | - Data sent between HW ports is sent on the wire to the external | |
298 | switch. | |
299 | ||
300 | .B veb | |
301 | - bridging happens in hardware. | |
302 | ||
22a98f51 RP |
303 | .TP |
304 | .BI self | |
305 | link setting is configured on specified physical device | |
306 | ||
307 | .TP | |
308 | .BI master | |
309 | link setting is configured on the software bridge (default) | |
310 | ||
25bc3d3d SA |
311 | .TP |
312 | .BR "\-t" , " \-timestamp" | |
313 | display current time when using monitor option. | |
22a98f51 | 314 | |
aa2f1335 VY |
315 | .SS bridge link show - list bridge port configuration. |
316 | ||
317 | This command displays the current bridge port configuration and flags. | |
318 | ||
d04bc300 SH |
319 | .SH bridge fdb - forwarding database management |
320 | ||
321 | .B fdb | |
322 | objects contain known Ethernet addresses on a link. | |
323 | ||
324 | .P | |
325 | The corresponding commands display fdb entries, add new entries, | |
7578ae88 | 326 | append entries, |
d04bc300 SH |
327 | and delete old ones. |
328 | ||
d611682a | 329 | .SS bridge fdb add - add a new fdb entry |
d04bc300 | 330 | |
d611682a | 331 | This command creates a new fdb entry. |
d04bc300 SH |
332 | |
333 | .TP | |
7578ae88 | 334 | .BI "LLADDR" |
d04bc300 SH |
335 | the Ethernet MAC address. |
336 | ||
337 | .TP | |
7578ae88 | 338 | .BI dev " DEV" |
d04bc300 SH |
339 | the interface to which this address is associated. |
340 | ||
d611682a | 341 | .B self |
cd8df30b RP |
342 | - the address is associated with the port drivers fdb. Usually hardware. |
343 | .sp | |
344 | ||
345 | .B master | |
346 | - the address is associated with master devices fdb. Usually software (default). | |
d611682a JF |
347 | .sp |
348 | ||
7578ae88 TR |
349 | .B router |
350 | - the destination address is associated with a router. | |
351 | Valid if the referenced device is a VXLAN type device and has | |
352 | route shortcircuit enabled. | |
353 | .sp | |
354 | ||
cd8df30b RP |
355 | .B use |
356 | - the address is in use. User space can use this option to | |
357 | indicate to the kernel that the fdb entry is in use. | |
358 | .sp | |
359 | ||
d04bc300 | 360 | .in -8 |
7578ae88 TR |
361 | The next command line parameters apply only |
362 | when the specified device | |
363 | .I DEV | |
364 | is of type VXLAN. | |
365 | .TP | |
366 | .BI dst " IPADDR" | |
367 | the IP address of the destination | |
368 | VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides. | |
369 | ||
370 | .TP | |
371 | .BI vni " VNI" | |
372 | the VXLAN VNI Network Identifier (or VXLAN Segment ID) | |
373 | to use to connect to the remote VXLAN tunnel endpoint. | |
374 | If omitted the value specified at vxlan device creation | |
375 | will be used. | |
376 | ||
377 | .TP | |
378 | .BI port " PORT" | |
379 | the UDP destination PORT number to use to connect to the | |
380 | remote VXLAN tunnel endpoint. | |
381 | If omitted the default value is used. | |
382 | ||
383 | .TP | |
384 | .BI via " DEVICE" | |
385 | device name of the outgoing interface for the | |
386 | VXLAN device driver to reach the | |
387 | remote VXLAN tunnel endpoint. | |
388 | ||
389 | .SS bridge fdb append - append a forwarding database entry | |
390 | This command adds a new fdb entry with an already known | |
391 | .IR LLADDR . | |
392 | Valid only for multicast link layer addresses. | |
393 | The command adds support for broadcast and multicast | |
394 | Ethernet MAC addresses. | |
395 | The Ethernet MAC address is added multiple times into | |
396 | the forwarding database and the vxlan device driver | |
397 | sends a copy of the data packet to each entry found. | |
398 | ||
399 | .PP | |
400 | The arguments are the same as with | |
401 | .BR "bridge fdb add" , | |
d04bc300 SH |
402 | |
403 | .SS bridge fdb delete - delete a forwarding database entry | |
404 | This command removes an existing fdb entry. | |
405 | ||
406 | .PP | |
407 | The arguments are the same as with | |
408 | .BR "bridge fdb add" , | |
409 | ||
410 | .SS bridge fdb show - list forwarding entries. | |
411 | ||
49572501 | 412 | This command displays the current forwarding table. |
d04bc300 SH |
413 | |
414 | .PP | |
415 | With the | |
416 | .B -statistics | |
a89d5329 | 417 | option, the command becomes verbose. It prints out the last updated |
d04bc300 SH |
418 | and last used time for each entry. |
419 | ||
54e9c3a3 PP |
420 | .SH bridge mdb - multicast group database management |
421 | ||
422 | .B mdb | |
423 | objects contain known IP multicast group addresses on a link. | |
424 | ||
425 | .P | |
426 | The corresponding commands display mdb entries, add new entries, | |
427 | and delete old ones. | |
428 | ||
429 | .SS bridge mdb add - add a new multicast group database entry | |
430 | ||
431 | This command creates a new mdb entry. | |
432 | ||
433 | .TP | |
434 | .BI dev " DEV" | |
435 | the interface where this group address is associated. | |
436 | ||
437 | .TP | |
438 | .BI port " PORT" | |
439 | the port whose link is known to have members of this multicast group. | |
440 | ||
441 | .TP | |
442 | .BI grp " GROUP" | |
443 | the IP multicast group address whose members reside on the link connected to | |
444 | the port. | |
445 | ||
446 | .B permanent | |
447 | - the mdb entry is permanent | |
448 | .sp | |
449 | ||
450 | .B temp | |
451 | - the mdb entry is temporary (default) | |
452 | .sp | |
453 | ||
6aac8617 NA |
454 | .TP |
455 | .BI vid " VID" | |
456 | the VLAN ID which is known to have members of this multicast group. | |
457 | ||
54e9c3a3 PP |
458 | .in -8 |
459 | .SS bridge mdb delete - delete a multicast group database entry | |
460 | This command removes an existing mdb entry. | |
461 | ||
462 | .PP | |
463 | The arguments are the same as with | |
464 | .BR "bridge mdb add" . | |
465 | ||
466 | .SS bridge mdb show - list multicast group database entries | |
467 | ||
468 | This command displays the current multicast group membership table. The table | |
469 | is populated by IGMP and MLD snooping in the bridge driver automatically. It | |
470 | can be altered by | |
471 | .B bridge mdb add | |
472 | and | |
473 | .B bridge mdb del | |
474 | commands manually too. | |
475 | ||
476 | .TP | |
477 | .BI dev " DEV" | |
478 | the interface only whose entries should be listed. Default is to list all | |
479 | bridge interfaces. | |
480 | ||
481 | .PP | |
482 | With the | |
483 | .B -details | |
a89d5329 | 484 | option, the command becomes verbose. It prints out the ports known to have |
54e9c3a3 PP |
485 | a connected router. |
486 | ||
ab938710 VY |
487 | .SH bridge vlan - VLAN filter list |
488 | ||
489 | .B vlan | |
490 | objects contain known VLAN IDs for a link. | |
491 | ||
492 | .P | |
493 | The corresponding commands display vlan filter entries, add new entries, | |
494 | and delete old ones. | |
495 | ||
496 | .SS bridge vlan add - add a new vlan filter entry | |
497 | ||
498 | This command creates a new vlan filter entry. | |
499 | ||
500 | .TP | |
501 | .BI dev " NAME" | |
502 | the interface with which this vlan is associated. | |
503 | ||
504 | .TP | |
505 | .BI vid " VID" | |
506 | the VLAN ID that identifies the vlan. | |
507 | ||
508 | .TP | |
509 | .BI pvid | |
510 | the vlan specified is to be considered a PVID at ingress. | |
511 | Any untagged frames will be assigned to this VLAN. | |
512 | ||
513 | .TP | |
514 | .BI untagged | |
515 | the vlan specified is to be treated as untagged on egress. | |
516 | ||
517 | .TP | |
518 | .BI self | |
a89d5329 | 519 | the vlan is configured on the specified physical device. Required if the |
ab938710 VY |
520 | device is the bridge device. |
521 | ||
522 | .TP | |
523 | .BI master | |
6274b0b7 | 524 | the vlan is configured on the software bridge (default). |
ab938710 VY |
525 | |
526 | .SS bridge vlan delete - delete a forwarding database entry | |
527 | This command removes an existing fdb entry. | |
528 | ||
529 | .PP | |
530 | The arguments are the same as with | |
531 | .BR "bridge vlan add". | |
532 | The | |
533 | .BR "pvid " and " untagged" | |
534 | flags are ignored. | |
535 | ||
536 | .SS bridge vlan show - list vlan configuration. | |
537 | ||
538 | This command displays the current VLAN filter table. | |
539 | ||
d04bc300 SH |
540 | .SH bridge monitor - state monitoring |
541 | ||
542 | The | |
543 | .B bridge | |
544 | utility can monitor the state of devices and addresses | |
a89d5329 | 545 | continuously. This option has a slightly different format. |
d04bc300 SH |
546 | Namely, the |
547 | .B monitor | |
548 | command is the first in the command line and then the object list follows: | |
549 | ||
550 | .BR "bridge monitor" " [ " all " |" | |
49572501 | 551 | .IR OBJECT-LIST " ]" |
d04bc300 SH |
552 | |
553 | .I OBJECT-LIST | |
554 | is the list of object types that we want to monitor. | |
555 | It may contain | |
54e9c3a3 | 556 | .BR link ", " fdb ", and " mdb "." |
d04bc300 SH |
557 | If no |
558 | .B file | |
559 | argument is given, | |
560 | .B bridge | |
561 | opens RTNETLINK, listens on it and dumps state changes in the format | |
562 | described in previous sections. | |
563 | ||
564 | .P | |
565 | If a file name is given, it does not listen on RTNETLINK, | |
566 | but opens the file containing RTNETLINK messages saved in binary format | |
efb16971 | 567 | and dumps them. |
d04bc300 SH |
568 | |
569 | .SH NOTES | |
570 | This command uses facilities added in Linux 3.0. | |
571 | ||
572 | Although the forwarding table is maintained on a per-bridge device basis | |
573 | the bridge device is not part of the syntax. This is a limitation of the | |
574 | underlying netlink neighbour message protocol. When displaying the | |
575 | forwarding table, entries for all bridges are displayed. | |
576 | Add/delete/modify commands determine the underlying bridge device | |
6274b0b7 | 577 | based on the bridge to which the corresponding ethernet device is attached. |
d04bc300 SH |
578 | |
579 | ||
580 | .SH SEE ALSO | |
581 | .BR ip (8) | |
49572501 | 582 | .SH BUGS |
d04bc300 SH |
583 | .RB "Please direct bugreports and patches to: " <netdev@vger.kernel.org> |
584 | ||
585 | .SH AUTHOR | |
586 | Original Manpage by Stephen Hemminger |