]>
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 " := { " | |
16 | .BR fdb " | " monitor " }" | |
17 | .sp | |
18 | ||
19 | .ti -8 | |
20 | .IR OPTIONS " := { " | |
21 | \fB\-V\fR[\fIersion\fR] | | |
22 | \fB\-s\fR[\fItatistics\fR] | |
23 | ||
24 | .ti -8 | |
d611682a | 25 | .BR "bridge fdb" " { " add " | " del " } " |
d04bc300 SH |
26 | .I LLADDR |
27 | .B dev | |
28 | .IR DEV " { " | |
d611682a JF |
29 | .BR local " | " temp " } { " |
30 | .BR self " } { " embedded " } " | |
d04bc300 SH |
31 | |
32 | .ti -8 | |
33 | .BR "bridge fdb" " [ " show " ] [ " | |
34 | .B dev | |
35 | .IR DEV " ]" | |
36 | ||
37 | .ti -8 | |
38 | .BR "bridge monitor" " [ " all " | " neigh " | " link " ]" | |
39 | ||
40 | .SH OPTIONS | |
41 | ||
42 | .TP | |
43 | .BR "\-V" , " -Version" | |
44 | print the version of the | |
45 | .B bridge | |
46 | utility and exit. | |
47 | ||
48 | .TP | |
49 | .BR "\-s" , " \-stats", " \-statistics" | |
50 | output more information. If the option | |
51 | appears twice or more, the amount of information increases. | |
52 | As a rule, the information is statistics or some time values. | |
53 | ||
54 | ||
55 | .SH BRIDGE - COMMAND SYNTAX | |
56 | ||
57 | .SS | |
58 | .I OBJECT | |
59 | ||
60 | .TP | |
61 | .B fdb | |
62 | - Forwarding Database entry. | |
63 | ||
64 | .SS | |
65 | .I COMMAND | |
66 | ||
67 | Specifies the action to perform on the object. | |
68 | The set of possible actions depends on the object type. | |
69 | As a rule, it is possible to | |
70 | .BR "add" , " delete" | |
71 | and | |
72 | .B show | |
73 | (or | |
74 | .B list | |
75 | ) objects, but some objects do not allow all of these operations | |
76 | or have some additional commands. The | |
77 | .B help | |
78 | command is available for all objects. It prints | |
79 | out a list of available commands and argument syntax conventions. | |
80 | .sp | |
81 | If no command is given, some default command is assumed. | |
82 | Usually it is | |
83 | .B list | |
84 | or, if the objects of this class cannot be listed, | |
85 | .BR "help" . | |
86 | ||
87 | .SH bridge fdb - forwarding database management | |
88 | ||
89 | .B fdb | |
90 | objects contain known Ethernet addresses on a link. | |
91 | ||
92 | .P | |
93 | The corresponding commands display fdb entries, add new entries, | |
94 | and delete old ones. | |
95 | ||
d611682a | 96 | .SS bridge fdb add - add a new fdb entry |
d04bc300 | 97 | |
d611682a | 98 | This command creates a new fdb entry. |
d04bc300 SH |
99 | |
100 | .TP | |
101 | .BI "ADDRESS" | |
102 | the Ethernet MAC address. | |
103 | ||
104 | .TP | |
105 | .BI dev " NAME" | |
106 | the interface to which this address is associated. | |
107 | ||
108 | .TP | |
109 | .in +8 | |
110 | .B local | |
111 | - the address is associated with a local interface on the system | |
112 | and is never forwarded. | |
113 | .sp | |
114 | ||
115 | .B temp | |
116 | - the address is a dynamic entry, and will be removed if not used. | |
117 | .sp | |
118 | ||
d611682a JF |
119 | .B self |
120 | - the address is associated with a software fdb (default) | |
121 | .sp | |
122 | ||
123 | .B embedded | |
124 | - the address is associated with an offloaded fdb | |
125 | .sp | |
126 | ||
d04bc300 SH |
127 | .in -8 |
128 | ||
129 | .SS bridge fdb delete - delete a forwarding database entry | |
130 | This command removes an existing fdb entry. | |
131 | ||
132 | .PP | |
133 | The arguments are the same as with | |
134 | .BR "bridge fdb add" , | |
135 | ||
136 | .SS bridge fdb show - list forwarding entries. | |
137 | ||
138 | This commands displays current forwarding table. | |
139 | ||
140 | .PP | |
141 | With the | |
142 | .B -statistics | |
143 | option, the command becomes verbose. It prints out the last updated | |
144 | and last used time for each entry. | |
145 | ||
146 | .SH bridge monitor - state monitoring | |
147 | ||
148 | The | |
149 | .B bridge | |
150 | utility can monitor the state of devices and addresses | |
151 | continuously. This option has a slightly different format. | |
152 | Namely, the | |
153 | .B monitor | |
154 | command is the first in the command line and then the object list follows: | |
155 | ||
156 | .BR "bridge monitor" " [ " all " |" | |
157 | .IR LISTofOBJECTS " ]" | |
158 | ||
159 | .I OBJECT-LIST | |
160 | is the list of object types that we want to monitor. | |
161 | It may contain | |
162 | .BR link ", and " fdb "." | |
163 | If no | |
164 | .B file | |
165 | argument is given, | |
166 | .B bridge | |
167 | opens RTNETLINK, listens on it and dumps state changes in the format | |
168 | described in previous sections. | |
169 | ||
170 | .P | |
171 | If a file name is given, it does not listen on RTNETLINK, | |
172 | but opens the file containing RTNETLINK messages saved in binary format | |
173 | and dumps them. Such a history file can be generated with the | |
174 | ||
175 | ||
176 | .SH NOTES | |
177 | This command uses facilities added in Linux 3.0. | |
178 | ||
179 | Although the forwarding table is maintained on a per-bridge device basis | |
180 | the bridge device is not part of the syntax. This is a limitation of the | |
181 | underlying netlink neighbour message protocol. When displaying the | |
182 | forwarding table, entries for all bridges are displayed. | |
183 | Add/delete/modify commands determine the underlying bridge device | |
184 | based on the bridge to which the coresponding ethernet device is attached. | |
185 | ||
186 | ||
187 | .SH SEE ALSO | |
188 | .BR ip (8) | |
189 | .br | |
190 | .RB "Please direct bugreports and patches to: " <netdev@vger.kernel.org> | |
191 | ||
192 | .SH AUTHOR | |
193 | Original Manpage by Stephen Hemminger |