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