]>
Commit | Line | Data |
---|---|---|
7d9809ef BP |
1 | .\" -*- nroff -*- |
2 | .de IQ | |
3 | . br | |
4 | . ns | |
5 | . IP "\\$1" | |
6 | .. | |
d2cb6c95 | 7 | .TH ovs\-vswitchd 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" |
812560d7 | 8 | .\" This program's name: |
064af421 BP |
9 | .ds PN ovs\-vswitchd |
10 | . | |
11 | .SH NAME | |
f30f26be | 12 | ovs\-vswitchd \- Open vSwitch daemon |
064af421 BP |
13 | . |
14 | .SH SYNOPSIS | |
80df177a | 15 | \fBovs\-vswitchd \fR[\fIdatabase\fR] |
064af421 BP |
16 | . |
17 | .SH DESCRIPTION | |
299a244b | 18 | A daemon that manages and controls any number of Open vSwitch switches |
f30f26be | 19 | on the local machine. |
064af421 | 20 | .PP |
80df177a BP |
21 | The \fIdatabase\fR argument specifies how \fBovs\-vswitchd\fR connects |
22 | to \fBovsdb\-server\fR. The default is \fBunix:@RUNDIR@/db.sock\fR. | |
23 | The following forms are accepted: | |
6f61c75b | 24 | .so ovsdb/remote-active.man |
c9f3f37a | 25 | .so ovsdb/remote-passive.man |
064af421 | 26 | .PP |
76343538 BP |
27 | \fBovs\-vswitchd\fR retrieves its configuration from \fIdatabase\fR at |
28 | startup. It sets up Open vSwitch datapaths and then operates | |
29 | switching across each bridge described in its configuration files. As | |
30 | the database changes, \fBovs\-vswitchd\fR automatically updates its | |
31 | configuration to match. | |
32 | .PP | |
299a244b | 33 | \fBovs\-vswitchd\fR switches may be configured with any of the following |
f30f26be | 34 | features: |
064af421 BP |
35 | . |
36 | .IP \(bu | |
37 | L2 switching with MAC learning. | |
38 | . | |
39 | .IP \(bu | |
40 | NIC bonding with automatic fail-over and source MAC-based TX load | |
41 | balancing ("SLB"). | |
42 | . | |
43 | .IP \(bu | |
44 | 802.1Q VLAN support. | |
45 | . | |
46 | .IP \(bu | |
47 | Port mirroring, with optional VLAN tagging. | |
48 | . | |
49 | .IP \(bu | |
50 | NetFlow v5 flow logging. | |
51 | . | |
52 | .IP \(bu | |
d1ae8299 | 53 | sFlow(R) monitoring. |
72b06300 BP |
54 | . |
55 | .IP \(bu | |
064af421 BP |
56 | Connectivity to an external OpenFlow controller, such as NOX. |
57 | . | |
58 | .PP | |
59 | Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time. | |
f30f26be | 60 | A single \fBovs\-vswitchd\fR can manage any number of switch instances, up |
064af421 BP |
61 | to the maximum number of supported Open vSwitch datapaths. |
62 | .PP | |
f30f26be | 63 | \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths |
064af421 BP |
64 | itself. Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for |
65 | managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use | |
66 | to modify datapaths when \fBovs\-vswitchd\fR is running can interfere with | |
67 | its operation. (\fBovs\-dpctl\fR may still be useful for diagnostics.) | |
68 | .PP | |
69 | An Open vSwitch datapath kernel module must be loaded for \fBovs\-vswitchd\fR | |
5fca1acd | 70 | to be useful. Please refer to the \fBINSTALL.Linux\fR file included in the |
064af421 BP |
71 | Open vSwitch distribution for instructions on how to build and load |
72 | the Open vSwitch kernel module. | |
73 | .PP | |
74 | .SH OPTIONS | |
4e312e69 | 75 | .IP "\fB\-\-mlockall\fR" |
86a06318 BP |
76 | Causes \fBovs\-vswitchd\fR to call the \fBmlockall()\fR function, to |
77 | attempt to lock all of its process memory into physical RAM, | |
78 | preventing the kernel from paging any of its memory to disk. This | |
79 | helps to avoid networking interruptions due to system memory pressure. | |
80 | .IP | |
81 | Some systems do not support \fBmlockall()\fR at all, and other systems | |
82 | only allow privileged users, such as the superuser, to use it. | |
83 | \fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is | |
84 | unavailable or unsuccessful. | |
85 | . | |
d1279464 PS |
86 | .SS "DPDK Options" |
87 | .IP "\fB\-\-dpdk\fR" | |
88 | Initialize \fBovs\-vswitchd\fR DPDK datapath. Refer to INSTALL.DPDK | |
89 | for details. | |
42dd41ef | 90 | .SS "Daemon Options" |
a7ff9bd7 BP |
91 | .ds DD \ |
92 | \fBovs\-vswitchd\fR detaches only after it has connected to the \ | |
93 | database, retrieved the initial configuration, and set up that \ | |
94 | configuration. | |
064af421 | 95 | .so lib/daemon.man |
42dd41ef GS |
96 | .SS "Service Options" |
97 | .so lib/service.man | |
ac300505 | 98 | .SS "Public Key Infrastructure Options" |
6f61c75b BP |
99 | .so lib/ssl.man |
100 | .so lib/ssl-bootstrap.man | |
b3fca241 | 101 | .SS "Logging Options" |
064af421 | 102 | .so lib/vlog.man |
8a986a0a GS |
103 | .SS "Other Options" |
104 | .so lib/unixctl.man | |
064af421 | 105 | .so lib/common.man |
064af421 | 106 | . |
b16fdafe BP |
107 | .SH "RUNTIME MANAGEMENT COMMANDS" |
108 | \fBovs\-appctl\fR(8) can send commands to a running | |
109 | \fBovs\-vswitchd\fR process. The currently supported commands are | |
110 | described below. The command descriptions assume an understanding of | |
76343538 | 111 | how to configure Open vSwitch. |
9e15c889 BP |
112 | .SS "GENERAL COMMANDS" |
113 | .IP "\fBexit\fR" | |
114 | Causes \fBovs\-vswitchd\fR to gracefully terminate. | |
e8fe3026 EJ |
115 | .IP "\fBqos/show\fR \fIinterface\fR" |
116 | Queries the kernel for Quality of Service configuration and statistics | |
117 | associated with the given \fIinterface\fR. | |
6d13e6dd PR |
118 | .IP "\fBbfd/show\fR [\fIinterface\fR]" |
119 | Displays detailed information about Bidirectional Forwarding Detection | |
120 | configured on \fIinterface\fR. If \fIinterface\fR is not specified, | |
121 | then displays detailed information about all interfaces with BFD | |
122 | enabled. | |
123 | .IP "\fBbfd/set-forwarding\fR [\fIinterface\fR] \fIstatus\fR" | |
124 | Force the fault status of the BFD module on \fIinterface\fR (or all | |
125 | interfaces if none is given) to be \fIstatus\fR. \fIstatus\fR can be | |
126 | "true", "false", or "normal" which reverts to the standard behavior. | |
ae75dae3 | 127 | .IP "\fBcfm/show\fR [\fIinterface\fR]" |
20c8e971 | 128 | Displays detailed information about Connectivity Fault Management |
ae75dae3 JP |
129 | configured on \fIinterface\fR. If \fIinterface\fR is not specified, |
130 | then displays detailed information about all interfaces with CFM | |
131 | enabled. | |
d7243b93 EJ |
132 | .IP "\fBcfm/set-fault\fR [\fIinterface\fR] \fIstatus\fR" |
133 | Force the fault status of the CFM module on \fIinterface\fR (or all | |
134 | interfaces if none is given) to be \fIstatus\fR. \fIstatus\fR can be | |
135 | "true", "false", or "normal" which reverts to the standard behavior. | |
fe4a02e4 EJ |
136 | .IP "\fBstp/tcn\fR [\fIbridge\fR]" |
137 | Forces a topology change event on \fIbridge\fR if it's running STP. This | |
138 | may cause it to send Topology Change Notifications to its peers and flush | |
139 | its MAC table.. If no \fIbridge\fR is given, forces a topology change | |
140 | event on all bridges. | |
b16fdafe BP |
141 | .SS "BRIDGE COMMANDS" |
142 | These commands manage bridges. | |
96e466a3 EJ |
143 | .IP "\fBfdb/flush\fR [\fIbridge\fR]" |
144 | Flushes \fIbridge\fR MAC address learning table, or all learning tables | |
145 | if no \fIbridge\fR is given. | |
b16fdafe BP |
146 | .IP "\fBfdb/show\fR \fIbridge\fR" |
147 | Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR, | |
08fdcc12 FL |
148 | along with the port on which it was learned and the age of the entry, |
149 | in seconds. | |
150 | .IP "\fBmdb/flush\fR [\fIbridge\fR]" | |
151 | Flushes \fIbridge\fR multicast snooping table, or all snooping tables | |
152 | if no \fIbridge\fR is given. | |
153 | .IP "\fBmdb/show\fR \fIbridge\fR" | |
154 | Lists each multicast group/VLAN pair learned by the specified \fIbridge\fR, | |
b16fdafe BP |
155 | along with the port on which it was learned and the age of the entry, |
156 | in seconds. | |
fa05809b BP |
157 | .IP "\fBbridge/reconnect\fR [\fIbridge\fR]" |
158 | Makes \fIbridge\fR drop all of its OpenFlow controller connections and | |
159 | reconnect. If \fIbridge\fR is not specified, then all bridges drop | |
160 | their controller connections and reconnect. | |
161 | .IP | |
162 | This command might be useful for debugging OpenFlow controller issues. | |
cdd35cff | 163 | . |
4e312e69 | 164 | .IP "\fBbridge/dump\-flows\fR \fIbridge\fR" |
cdd35cff | 165 | Lists all flows in \fIbridge\fR, including those normally hidden to |
4e312e69 | 166 | commands such as \fBovs\-ofctl dump\-flows\fR. Flows set up by mechanisms |
cdd35cff JP |
167 | such as in-band control and fail-open are hidden from the controller |
168 | since it is not allowed to modify or override them. | |
b16fdafe BP |
169 | .SS "BOND COMMANDS" |
170 | These commands manage bonded ports on an Open vSwitch's bridges. To | |
171 | understand some of these commands, it is important to understand a | |
be02e7c3 EJ |
172 | detail of the bonding implementation called ``source load balancing'' |
173 | (SLB). Instead of directly assigning Ethernet source addresses to | |
174 | slaves, the bonding implementation computes a function that maps an | |
175 | 48-bit Ethernet source addresses into an 8-bit value (a ``MAC hash'' | |
176 | value). All of the Ethernet addresses that map to a single 8-bit | |
177 | value are then assigned to a single slave. | |
b16fdafe BP |
178 | .IP "\fBbond/list\fR" |
179 | Lists all of the bonds, and their slaves, on each bridge. | |
064af421 | 180 | . |
c33a8a25 EJ |
181 | .IP "\fBbond/show\fR [\fIport\fR]" |
182 | Lists all of the bond-specific information (updelay, downdelay, time | |
183 | until the next rebalance) about the given bonded \fIport\fR, or all | |
184 | bonded ports if no \fIport\fR is given. Also lists information about | |
185 | each slave: whether it is enabled or disabled, the time to completion | |
186 | of an updelay or downdelay if one is in progress, whether it is the | |
187 | active slave, the hashes assigned to the slave. Any LACP information | |
188 | related to this bond may be found using the \fBlacp/show\fR command. | |
189 | . | |
b16fdafe | 190 | .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR" |
be02e7c3 EJ |
191 | Only valid for SLB bonds. Assigns a given MAC hash to a new slave. |
192 | \fIport\fR specifies the bond port, \fIhash\fR the MAC hash to be | |
193 | migrated (as a decimal number between 0 and 255), and \fIslave\fR the | |
194 | new slave to be assigned. | |
b16fdafe BP |
195 | .IP |
196 | The reassignment is not permanent: rebalancing or fail-over will | |
197 | cause the MAC hash to be shifted to a new slave in the usual | |
198 | manner. | |
199 | .IP | |
200 | A MAC hash cannot be migrated to a disabled slave. | |
4e312e69 | 201 | .IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR" |
b16fdafe BP |
202 | Sets \fIslave\fR as the active slave on \fIport\fR. \fIslave\fR must |
203 | currently be enabled. | |
204 | .IP | |
205 | The setting is not permanent: a new active slave will be selected | |
206 | if \fIslave\fR becomes disabled. | |
4e312e69 BP |
207 | .IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR" |
208 | .IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR" | |
b16fdafe BP |
209 | Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any |
210 | updelay (or downdelay). | |
211 | .IP | |
212 | This setting is not permanent: it persists only until the carrier | |
213 | status of \fIslave\fR changes. | |
672d18b2 | 214 | .IP "\fBbond/hash\fR \fImac\fR [\fIvlan\fR] [\fIbasis\fR]" |
e58de0e3 | 215 | Returns the hash value which would be used for \fImac\fR with \fIvlan\fR |
672d18b2 | 216 | and \fIbasis\fR if specified. |
064af421 | 217 | . |
5dab8ece | 218 | .IP "\fBlacp/show\fR [\fIport\fR]" |
6aa74308 EJ |
219 | Lists all of the LACP related information about the given \fIport\fR: |
220 | active or passive, aggregation key, system id, and system priority. Also | |
221 | lists information about each slave: whether it is enabled or disabled, | |
222 | whether it is attached or detached, port id and priority, actor | |
5dab8ece JP |
223 | information, and partner information. If \fIport\fR is not specified, |
224 | then displays detailed information about all interfaces with CFM | |
225 | enabled. | |
fceef209 DDP |
226 | .SS "DPCTL DATAPATH DEBUGGING COMMANDS" |
227 | The primary way to configure \fBovs\-vswitchd\fR is through the Open | |
228 | vSwitch database, e.g. using \fBovs\-vsctl\fR(8). These commands | |
229 | provide a debugging interface for managing datapaths. They implement | |
230 | the same features (and syntax) as \fBovs\-dpctl\fR(8). Unlike | |
231 | \fBovs\-dpctl\fR(8), these commands work with datapaths that are | |
232 | integrated into \fBovs\-vswitchd\fR (e.g. the \fBnetdev\fR datapath | |
233 | type). | |
234 | .PP | |
235 | . | |
236 | .ds DX \fBdpctl/\fR | |
237 | .de DO | |
238 | \\$2 \\$1 \\$3 | |
239 | .. | |
240 | .so lib/dpctl.man | |
6aa74308 | 241 | . |
6553d06b DDP |
242 | .SS "DPIF-NETDEV COMMANDS" |
243 | These commands are used to expose internal information (mostly statistics) | |
244 | about the ``dpif-netdev'' userspace datapath. If there is only one datapath | |
245 | (as is often the case, unless \fBdpctl/\fR commands are used), the \fIdp\fR | |
246 | argument can be omitted. | |
247 | .IP "\fBdpif-netdev/pmd-stats-show\fR [\fIdp\fR]" | |
248 | Shows performance statistics for each pmd thread of the datapath \fIdp\fR. | |
249 | The special thread ``main'' sums up the statistics of every non pmd thread. | |
250 | The sum of ``emc hits'', ``masked hits'' and ``miss'' is the number of | |
251 | packets received by the datapath. Cycles are counted using the TSC or similar | |
252 | facilities (when available on the platform). To reset these counters use | |
253 | \fBdpif-netdev/pmd-stats-clear\fR. The duration of one cycle depends on the | |
254 | measuring infrastructure. | |
255 | .IP "\fBdpif-netdev/pmd-stats-clear\fR [\fIdp\fR]" | |
256 | Resets to zero the per pmd thread performance numbers shown by the | |
257 | \fBdpif-netdev/pmd-stats-show\fR command. It will NOT reset datapath or | |
258 | bridge statistics, only the values shown by the above command. | |
259 | . | |
27022416 | 260 | .so ofproto/ofproto-dpif-unixctl.man |
7aa697dd | 261 | .so ofproto/ofproto-unixctl.man |
b16fdafe | 262 | .so lib/vlog-unixctl.man |
149ff68a | 263 | .so lib/memory-unixctl.man |
6901e5e2 | 264 | .so lib/coverage-unixctl.man |
a36de779 | 265 | .so ofproto/ofproto-tnl-unixctl.man |
7a7708a0 | 266 | . |
42ed0063 BP |
267 | .SH "OPENFLOW IMPLEMENTATION" |
268 | . | |
269 | .PP | |
270 | This section documents aspects of OpenFlow for which the OpenFlow | |
271 | specification requires documentation. | |
272 | . | |
273 | .SS "Packet buffering." | |
274 | The OpenFlow specification, version 1.2, says: | |
275 | . | |
276 | .IP | |
277 | Switches that implement buffering are expected to expose, through | |
278 | documentation, both the amount of available buffering, and the length | |
279 | of time before buffers may be reused. | |
280 | . | |
281 | .PP | |
fb405080 | 282 | Open vSwitch maintains a separate set of 256 packet buffers for each |
42ed0063 BP |
283 | OpenFlow connection. Any given packet buffer is preserved until it is |
284 | referenced by an \fBOFPT_FLOW_MOD\fR or \fBOFPT_PACKET_OUT\fR request | |
285 | or for 5 seconds, whichever comes first. | |
286 | . | |
7a7708a0 BP |
287 | .SH "LIMITS" |
288 | . | |
289 | .PP | |
290 | We believe these limits to be accurate as of this writing. These | |
291 | limits assume the use of the Linux kernel datapath. | |
292 | . | |
293 | .IP \(bu | |
991d922c | 294 | \fBovs\-vswitchd\fR started through \fBovs\-ctl\fR(8) provides a limit of 7500 |
8ed70321 GS |
295 | file descriptors. The limits on the number of bridges and ports is decided by |
296 | the availability of file descriptors. With the Linux kernel datapath, creation | |
297 | of a single bridge consumes 3 file descriptors and adding a port consumes | |
298 | 1 file descriptor. Performance will degrade beyond 1,024 ports per bridge due | |
299 | to fixed hash table sizing. Other platforms may have different limitations. | |
7a7708a0 BP |
300 | . |
301 | .IP \(bu | |
2be9d4f0 BP |
302 | 2,048 MAC learning entries per bridge, by default. (This is |
303 | configurable via \fBother\-config:mac\-table\-size\fR in the | |
304 | \fBBridge\fR table. See \fBovs\-vswitchd.conf.db\fR(5) for details.) | |
7a7708a0 BP |
305 | . |
306 | .IP \(bu | |
307 | Kernel flows are limited only by memory available to the kernel. | |
308 | Performance will degrade beyond 1,048,576 kernel flows per bridge with | |
309 | a 32-bit kernel, beyond 262,144 with a 64-bit kernel. | |
310 | (\fBovs\-vswitchd\fR should never install anywhere near that many | |
311 | flows.) | |
312 | . | |
313 | .IP \(bu | |
314 | OpenFlow flows are limited only by available memory. Performance is | |
315 | linear in the number of unique wildcard patterns. That is, an | |
316 | OpenFlow table that contains many flows that all match on the same | |
317 | fields in the same way has a constant-time lookup, but a table that | |
318 | contains many flows that match on different fields requires lookup | |
319 | time linear in the number of flows. | |
320 | . | |
321 | .IP \(bu | |
322 | 255 ports per bridge participating in 802.1D Spanning Tree Protocol. | |
323 | . | |
324 | .IP \(bu | |
325 | 32 mirrors per bridge. | |
326 | . | |
327 | .IP \(bu | |
328 | 15 bytes for the name of a port. (This is a Linux kernel limitation.) | |
329 | . | |
064af421 BP |
330 | .SH "SEE ALSO" |
331 | .BR ovs\-appctl (8), | |
76343538 | 332 | .BR ovsdb\-server (1), |
5fca1acd | 333 | \fBINSTALL.Linux\fR in the Open vSwitch distribution. |